Wiki source code of BestPractices
Version 1.1 by Vincent Massol on 2006/12/05
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | 1 Best Practices | ||
| 2 | |||
| 3 | 1.1 Naming Best Practices | ||
| 4 | |||
| 5 | 1.1.1 Application | ||
| 6 | * Each application must have its own Space if a user interface is needed. | ||
| 7 | |||
| 8 | 1.1.1 Classes | ||
| 9 | * Classes must be in the XWiki space | ||
| 10 | * The name must end with "Class" like "TagClass" | ||
| 11 | |||
| 12 | 1.1.1 Macro | ||
| 13 | * Macro must be in the XWiki space | ||
| 14 | * The name must end with "Macro" like "TagMacro" | ||
| 15 | |||
| 16 | 1.1.1 Sheets | ||
| 17 | * Sheets must be in the XWiki space | ||
| 18 | * The name must end with "Sheet" like "TagSheet" | ||
| 19 | |||
| 20 | 1.1.1 Templates | ||
| 21 | * Templates must be in the XWiki space | ||
| 22 | * The name must end with "Templates" like "TagTemplates" | ||
| 23 | |||
| 24 | 1.1.1 Objects | ||
| 25 | * Objects must be in their own space | ||
| 26 | |||
| 27 | <span style="background-color:yellow">TODO: Explain the reasons behind these practices</span> |
