1352
Comment:
|
← Revision 19 as of 2016-05-23 16:35:14 ⇥
1491
|
Deletions are marked like this. | Additions are marked like this. |
Line 4: | Line 4: |
Line 6: | Line 5: |
Line 10: | Line 8: |
General Forumla: [form]_[type]_[purpose] Casing: Camel case (modified) * No spaces are allowed in variable names. * An underscore is used to separate words when naming. |
General Forumla: ['''form''']_['''type''']_['''purpose'''] Casing: Camel case (modified) * No spaces are allowed in variable names. * An underscore is used to separate words when naming. |
Line 16: | Line 16: |
Forms: | |
Line 20: | Line 19: |
Types (GUI Elements): Examples: main_LB_Degrees, main_DD_CurrTerm |
Examples: main_LB_Degrees, main_DD_!CurrTerm |
Line 23: | Line 21: |
BT (Button) CB (Check Box) CH (Chart) DD (Drop Down List Box) DT (Date Entry) EB (Edit Box) LB (List Box) MB (Memo Box) MC (Multi-Column List Box) RB (Radio Button) |
* BT (Button) * CB (Check Box) * CH (Chart) * DD (Drop Down List Box) * DT (Date Entry) * EB (Edit Box) * LB (List Box) * MB (Memo Box) * MC (Multi-Column List Box) * RB (Radio Button) |
Line 35: | Line 33: |
The "purpose" should provide a what or how this object will be used. Examples: sql_main_GetStudentID, main_DD_CurrTerm, main_LB_Donors |
Examples: sql_main_GetStudentID, main_DD_!CurrTerm, main_LB_Donors |
Line 38: | Line 35: |
=== Other Types === Some variables are outside of the Form. With these, we prefix them with the External Type first. sql (SQL) res (Results) |
The "purpose" should provide a what or how this object will be used. |
Line 44: | Line 37: |
SQL variables: Examples: sql_main_ChrtEnrl (an SQL variable to drive an enrollment chart on form Main … etc) |
=== Other Types (SQL / Results) === Examples: sql_main_!ChrtEnrl (an SQL variable to drive an enrollment chart on form Main … etc) |
Line 47: | Line 40: |
Results (from an on-screen multi-column or OLAP): Examples: res_main_MC_AllEnrolled, res_contacts_OLAP_DonatePctTarget |
Examples: res_main_MC_!AllEnrolled, res_contacts_OLAP_!DonatePctTarget Some variables are outside of the Form. With these, we prefix them with the External Type first. sql (SQL) res (Results) |
Line 51: | Line 45: |
'''''Note'''''': As we learn more about the Evisions Argos product, these standards and best practices will grow and be revised to suit our environment more closely. '''''''' ''' |
Argos Naming Conventions
Contents
General Rules
General Forumla: [form]_[type]_[purpose]
Casing: Camel case (modified)
- No spaces are allowed in variable names.
- An underscore is used to separate words when naming.
Forms
Examples: main, contacts, charts
Types
Examples: main_LB_Degrees, main_DD_CurrTerm
- BT (Button)
- CB (Check Box)
- CH (Chart)
- DD (Drop Down List Box)
- DT (Date Entry)
- EB (Edit Box)
- LB (List Box)
- MB (Memo Box)
- MC (Multi-Column List Box)
- RB (Radio Button)
Purpose
Examples: sql_main_GetStudentID, main_DD_CurrTerm, main_LB_Donors
The "purpose" should provide a what or how this object will be used.
Other Types (SQL / Results)
Examples: sql_main_ChrtEnrl (an SQL variable to drive an enrollment chart on form Main … etc)
Examples: res_main_MC_AllEnrolled, res_contacts_OLAP_DonatePctTarget
Some variables are outside of the Form. With these, we prefix them with the External Type first. sql (SQL) res (Results)
Note: As we learn more about the Evisions Argos product, these standards and best practices will grow and be revised to suit our environment more closely.