STANDARDS

NAME

standards - Defines standards for extenso

DESCRIPTION

Defines all sorts of standards for Extenso

General convention

• Never use plurial
• Use English names
• All lowercase
• Use underscores (_) to separate words

table_name

• Singular
• Characters a-z 0-9 and _
• English
• sn_ is reserved for Extenso

Rules for modules

Use English words
Do not use plural words

Module names
developerName_moduleName

Directory names
/module/developerName/moduleName/resource/...

/module/developerName/moduleName/widget/
/module/developerName/moduleName/css/...

Table names
developerName_moduleName_tableName

For the resources:
Reference Code: moduleName_reference
File ( Français ): /extenso/html/extranet/module/developerName/moduleName/fr/
File ( English ):  /extenso/html/extranet/module/developerName/moduleName/en/

Exception for assets available to the public (ex.: links in emails), the directory must not contain extranet, it must be
/extenso/html/module/developerName/moduleName/fr/

url : same as File without "html"
Module: specify the module

For the ct:
Module: specify the module

For images, create a duplicate in
module/developerName/moduleName/html/image/

Here is a list of all directories:

• For a module (A module can be used in another site or if it uses multiple files):
  • /module/sed/directmail/function
  • /module/sed/directmail/publish
  • /module/sed/directmail/include
  • /module/sed/directmail/resource
  • /module/sed/directmail/template
  • /module/sed/directmail/widget
  • /module/sed/directmail/trigger
  • /module/sed/directmail/html
  • /module/sed/directmail/stored_procedure
• Not a module:
  • /widget
  • /publish
  • /include
  • /resource
  • /template
  • /widget
  • /trigger
  • /stored_procedure

EXAMPLES

Examples from Direct Mail:
Module Name: sed_directmail
Directory Name: /module/sed/directmail/resource/
Table Name: sed_directmail_list
Reference Code: sed_directmail_start
File: /extenso/html/extranet/module/sed/directmail/fr/

AUTHOR

Written by Pierre Laplante, <laplante@sednove.com>