Revision [16045]

This is an old revision of PageNamingConvention made by BrianKoontz on 2007-02-03 12:53:54.

 

WikkaDocumentation Wikka Documentation

Naming convention for Pages on this wiki


Since this wiki gets bigger and bigger, we may want to add some more structure to how some (special-purpose) pages are named.
 


Development


Templates


The name of a template page should take the form xxxTemplate where 'xxx' indicates the type of page it is a template for. Templates should be placed in Category Template (without the space).

Workarounds


The name of a workaround page should take the form xxxWorkaround where 'xxx' gives a short summary/idea of the problem. Workaround pages should be placed in the Category Workaround (without the space).


Documentation


Actions


Each action should get two pages (where xxx stands for the file-name):


The official actions need to be listed at ActionInfo (now named UsingActions) and on the WikkaSystemFiles.

Handlers


Each handler should get two pages (where xxx stands for the file-name):


The official handlers need to be listed at HandlerInfo and on the WikkaSystemFiles.

Formatters


Each formatter should get two pages (where xxx stands for the file-name):


The official formatters need to be listed at FormatterInfo and on the WikkaSystemFiles.

Patches

(proposal)
Patches that can be applied to code from any of the categories above, but that do not in and of themselves constitute major restructuring or functionality, can be placed in one page (where xxx stands for the action, handler, or formatter, and yyy is a short description):


The patch itself should be enclosed by %% formatting tokens. A unified diff (diff -u or rcsdiff -u) is preferred. Be sure to specify the Wikka version for which the patch is applicable, and include Category UserContributions (without the space) at the bottom of the page.




CategoryDocumentation, CategoryDevelopmentDocumentation
There are 9 comments on this page. [Show comments]
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki