Revision history for PageNamingConvention
Revision [22870]
Last edited on 2016-05-20 07:38:42 by BrianKoontz [Replaces old-style internal links with new pipe-split links.]Additions:
This page can now be found on the [[Docs:PageNamingConvention | Wikka Documentation Server]].
An archive of [[http://wikkawiki.org/PageNamingConvention/revisions | old revisions of this page]] is still available for reference.<<
An archive of [[http://wikkawiki.org/PageNamingConvention/revisions | old revisions of this page]] is still available for reference.<<
Deletions:
An archive of [[http://wikkawiki.org/PageNamingConvention/revisions
old revisions of this page]] is still available for reference.<<
Additions:
<<===This page has moved===
This page can now be found on the [[Docs:PageNamingConvention Wikka Documentation Server]].
Thanks for updating your bookmarks!
An archive of [[http://wikkawiki.org/PageNamingConvention/revisions
old revisions of this page]] is still available for reference.<<
::c::
CategoryMigratedDocs
This page can now be found on the [[Docs:PageNamingConvention Wikka Documentation Server]].
Thanks for updating your bookmarks!
An archive of [[http://wikkawiki.org/PageNamingConvention/revisions
old revisions of this page]] is still available for reference.<<
::c::
CategoryMigratedDocs
Deletions:
=====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.
===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):
- **xxxyyyPatch** (Both the patch and documentation can be contained in the same page)
- **Example:** PageIndexNotesPatch (displays page notes upon invocation of the ""PageIndex"" action)
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
Additions:
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.
Deletions:
Additions:
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. Be sure to include **""Category UserContributions""** (without the space) at the bottom of the page.
Deletions:
Additions:
===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):
- **xxxyyyPatch** (Both the patch and documentation can be contained in the same page)
- **Example:** PageIndexNotesPatch (displays page notes upon invocation of the ""PageIndex"" action)
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. Be sure to include **""CategoryUserContributions""** at the bottom of the page.
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):
- **xxxyyyPatch** (Both the patch and documentation can be contained in the same page)
- **Example:** PageIndexNotesPatch (displays page notes upon invocation of the ""PageIndex"" action)
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. Be sure to include **""CategoryUserContributions""** at the bottom of the page.
Revision [8814]
Edited on 2005-06-03 19:08:34 by JavaWoman [correction (category should not be in page name)]Additions:
- **xxxHandler** this is the development page.
- **xxxFormatter** this is the development page.
- **xxxFormatter** this is the development page.
Deletions:
- **xxxFormatterDevelopment** this is the development page.
Additions:
- **xxxAction** this is the development page for the action.
Deletions:
Additions:
CategoryDocumentation, CategoryDevelopmentDocumentation
Deletions:
Additions:
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).
Deletions:
Revision [8427]
Edited on 2005-05-24 13:25:30 by JavaWoman [layout + reformulation of templates, workarounds]Additions:
>>Since this wiki gets bigger and bigger, we may want to add some more structure to how some (special-purpose) pages are named.::c::
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).
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).
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).
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).
Deletions:
>>::c::
The name of a template page should end with -Template. They should be placed in Category emplate (without the space).
A workaround should begin with a name who gives a short summary/idea of the problem and end with -Workaround. They should be placed in the Category Workaround (without the space).
Additions:
>>**See also**
[[DocumentationGuidelines Guidelines for Documentation pages]]
>>::c::
[[DocumentationGuidelines Guidelines for Documentation pages]]
>>::c::
Revision [8415]
Edited on 2005-05-24 10:34:36 by NilsLindenberg [added templates, workarounds, removed the language suffix]Additions:
====Development====
===Templates===
The name of a template page should end with -Template. They should be placed in Category emplate (without the space).
===Workarounds===
A workaround should begin with a name who gives a short summary/idea of the problem and end with -Workaround. They should be placed in the Category Workaround (without the space).
====Documentation====
===Actions===
- **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.
===Handlers===
- **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.
===Formatters===
- **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.
===Templates===
The name of a template page should end with -Template. They should be placed in Category emplate (without the space).
===Workarounds===
A workaround should begin with a name who gives a short summary/idea of the problem and end with -Workaround. They should be placed in the Category Workaround (without the space).
====Documentation====
===Actions===
- **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.
===Handlers===
- **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.
===Formatters===
- **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.
Deletions:
- **xxxActionInfoEN** 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.
====Handlers====
- **xxxHandlerInfoEN** 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.
====Formatters====
- **xxxFormatterInfoEN** 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.
====Workarounds====
//follows//
Additions:
====Workarounds====
//follows//
//follows//
Additions:
Since this wiki gets bigger and bigger, we may want to add some more structure to how some (special-purpose) pages are named.
Deletions:
Additions:
The official handlers need to be listed at HandlerInfo and on the WikkaSystemFiles.
The official formatters need to be listed at FormatterInfo and on the WikkaSystemFiles.
The official formatters need to be listed at FormatterInfo and on the WikkaSystemFiles.
Deletions:
The official actions need to be listed at FormatterInfo and on the WikkaSystemFiles.
Additions:
[[WikkaDocumentation Wikka Documentation]]
----
=====Naming convention for Pages on this wiki=====
Since this wiki gets bigger and bigger, we may want to add some mores structure to the way, some pages are named.
====Actions====
Each action should get two pages (where xxx stands for the file-name):
- **xxxActionDevelopment** this is the development page for the action.
- **xxxActionInfoEN** 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):
- **xxxHandlerDevelopment** this is the development page.
- **xxxHandlerInfoEN** 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 HandlerInfo and on the WikkaSystemFiles.
====Formatters====
Each formatter should get two pages (where xxx stands for the file-name):
- **xxxFormatterDevelopment** this is the development page.
- **xxxFormatterInfoEN** 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 FormatterInfo and on the WikkaSystemFiles.
----
CategoryDocumentation, CategoryDevelopment
----
=====Naming convention for Pages on this wiki=====
Since this wiki gets bigger and bigger, we may want to add some mores structure to the way, some pages are named.
====Actions====
Each action should get two pages (where xxx stands for the file-name):
- **xxxActionDevelopment** this is the development page for the action.
- **xxxActionInfoEN** 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):
- **xxxHandlerDevelopment** this is the development page.
- **xxxHandlerInfoEN** 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 HandlerInfo and on the WikkaSystemFiles.
====Formatters====
Each formatter should get two pages (where xxx stands for the file-name):
- **xxxFormatterDevelopment** this is the development page.
- **xxxFormatterInfoEN** 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 FormatterInfo and on the WikkaSystemFiles.
----
CategoryDocumentation, CategoryDevelopment
Deletions:
----
=====Title of the page =====
//This page is a **template** intended for documentation of **official Wikka features**. This page belongs to CategoryTemplate (which contains more handy templates). To create a Wikka **documentation** page, [[http://wikka.jsnx.com/DocumentationTemplate/clone clone this page]] (most documentation page names end in 'Info' so it's useful to stick to that convention), replace the title with a meaningful one and replace this paragraph with the actual page content.//
----
CategoryDocumentation
