Difference between revisions of "WebConfig - Requirements guideline"

Latest revision as of 05:46, 18 October 2013

<accesscontrol>Main:MyGroup</accesscontrol> 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

@@ Line 1: / Line 1: @@
+<accesscontrol>Main:MyGroup</accesscontrol>
 There are some requirements you should specify clearly when making a request for the new webconfig keys:
@@ Line 16: / Line 17: @@
 '''Description'''
-| What is that&nbsp;? 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 32: @@
 '''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'''
-| The recommend value
+| How should the administrator of the site determine what to set this value to.
 |-
 |
@@ Line 52: / Line 53: @@
 | Give us an example of the new key plz
 |}
+[[Category:Technical_guidelines ]]