Naming convention for framesets

Attribute(s)

  • Naming convention

    Description

    A Frameset Name must be descriptive, but not to long.

    Motivation

    By using a naming convention for objects, System Developers create consistency and recognizability throughout the application and over projectteams.

    Example / Details

    Frameset names must conform to the following standards:

    A Frameset name may consist of letters, numbers and underscores.

    Framesets always begin with a capital letter. Each new word in a Frameset name
    should also begin with a capital letter.

    e.g.
    Incorrect
    Correct

    name
    Name

    lastname
    LastName

    Underscores may also be used to separate words in a Frameset name, but only
    where it is necessary for readability (as is the case for computed for display
    Framesets).

    e.g.
    Incorrect
    Correct

    User_Name
    UserName

    User_Name_Disp
    UserName_Disp

    Framesets created to hold HTML code for form enhancement should be contain the
    suffix '_HTML'. Be aware when HTML is generated, computed text is prefered.

    Frameset names must be descriptive in nature so that a designer or
    administrator can quickly ascertain its function

    e.g.
    Incorrect
    Correct

    Frameset_A
    UserNameLast

    Frameset Names must be in English

    Standard Template Frameset names always start with the prefix 'T_'.
    When a developer uses a Template Frameset (and underlying formulas) as a
    starting-point, but customizes it for a specific application, the prefix must
    be removed.

    e.g.
    T_Creator


    T_CreateDate