Wiki source for PageNamingConvention


Show raw source

[[WikkaDocumentation | Wikka Documentation]]
----
=====Naming convention for Pages on this wiki=====

>>**See also**
[[DocumentationGuidelines | Guidelines for Documentation pages]]
>>Since this wiki gets bigger and bigger, we may want to add some more structure to how some (special-purpose) pages are named.::c::

====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):

- **xxxAction** this is the development page for the action.
- **xxxActionInfo** this is the documentation page. If it is translated into another language, the EN in the name should be replaced by the appropriate value of the language. On this page should appear no code.

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):

- **xxxHandler** this is the development page.
- **xxxHandlerInfo** this is the documentation page. If it is translated into another language, the EN in the name should be replaced by the appropriate value of the language. On this page should appear no code.

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):

- **xxxFormatter** this is the development page.
- **xxxFormatterInfo** this is the documentation page. If it is translated into another language, the EN in the name should be replaced by the appropriate value of the language. On this page should appear no code.

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


----
CategoryDocumentation, CategoryDevelopmentDocumentation
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki