Wiki source code of BestPractices
Version 1.5 by Vincent Massol on 2007/10/25
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | 1 Best Practices | ||
| 2 | |||
| 3 | #toc("" "" "") | ||
| 4 | |||
| 5 | 1.1 Check for Object existence in Class Sheets documents | ||
| 6 | |||
| 7 | Class sheet documents should be written using the following construct (this is an example for displaying documents containing XWiki.XWikiUsers objects): | ||
| 8 | |||
| 9 | {code} | ||
| 10 | #set($obj = $doc.getObject("XWiki.XWikiUsers")) | ||
| 11 | #if(!$obj) | ||
| 12 | 1 User Sheet | ||
| 13 | This stylesheet must be applied on a document containing a XWiki.XWikiUsers object. | ||
| 14 | #else | ||
| 15 | 1 $msg.get("userProfile", [$xwiki.getUserName($doc.fullName, false)]) | ||
| 16 | ... | ||
| 17 | #end | ||
| 18 | {code} | ||
| 19 | |||
| 20 | #info("The 'if' tests first for the non existence. This is so that XWiki extract the title from the ~~1 User Sheet~~, which is a proper title to display when viewsing the sheet page, instead of the computed name which will usually display something wrong.") |
