BestPractices

Version 1.1 by Vincent Massol on 2006/12/05

Best Practices

Naming Best Practices

Application

  • Each application must have its own Space if a user interface is needed.

Classes

  • Classes must be in the XWiki space
  • The name must end with "Class" like "TagClass"

Macro

  • Macro must be in the XWiki space
  • The name must end with "Macro" like "TagMacro"

Sheets

  • Sheets must be in the XWiki space
  • The name must end with "Sheet" like "TagSheet"

Templates

  • Templates must be in the XWiki space
  • The name must end with "Templates" like "TagTemplates"

Objects

  • Objects must be in their own space

TODO: Explain the reasons behind these practices

Tags:
   

Get Connected