Revision history for DocumentationGuidelines
Deletions:
Revision [1359]
Edited on 2008-12-01 07:53:40 by VincentMayoux [good to check before editing but how to -> added a link to SearchHelp]Additions:
~-When creating a new documentation entry, please check that another page on the same topic does not already exist. [[SearchHelp | Searching in Wikka]]
Deletions:
Additions:
~-Documentation pages should be linked from the [[HomePage | official Wikka Documentation page]]
Deletions:
Additions:
~-Documentation pages should be linked from the [[HomePage official Wikka Documentation page]]
~-All contributions to the docs should be released under the {{license type="CC-BY-SA" display="inline"}}
~-All contributions to the docs should be released under the {{license type="CC-BY-SA" display="inline"}}
Deletions:
Deletions:
Deletions:
Additions:
~-Documentation pages should be linked from the [[HomePage | official Wikka Documentation page]]
Deletions:
Additions:
~You can use [[CategoryTemplate | templates]] to generate well-formatted documentation pages.
Additions:
[[WikkaDocumentation | Wikka Documentation]]
----
=====Documentation Guidelines=====
To preserve the overall consistency of documentation pages, please respect the following guidelines when creating/editing a documentation page.
~-When creating a new documentation entry, please check that another page on the same topic does not already exist
~-Documentation pages should be linked from the [[WikkaDocumentation | official Wikka Documentation page]]
~-Please add the following header and footer to every documentation page:
~ ---
~%%
HomePage
----
====Title of the page ====
Here goes page content
...
...
...
...
----
CategoryEN
%%
~Please notice that CategoryEN corresponds to pages written //in English//. There are [[CategoryCategory | other Categories]] available.
~ You can directly generate well-formatted documentation pages by "cloning" the [[http://docs.wikkawiki.org/DocumentationTemplate/clone | DocumentationTemplate]]
~
~-Do not create documentation entries for features/actions that are not yet included in the [[WikkaReleaseNotes | official Wikka releases]]
----
----
=====Documentation Guidelines=====
To preserve the overall consistency of documentation pages, please respect the following guidelines when creating/editing a documentation page.
~-When creating a new documentation entry, please check that another page on the same topic does not already exist
~-Documentation pages should be linked from the [[WikkaDocumentation | official Wikka Documentation page]]
~-Please add the following header and footer to every documentation page:
~ ---
~%%
HomePage
----
====Title of the page ====
Here goes page content
...
...
...
...
----
CategoryEN
%%
~Please notice that CategoryEN corresponds to pages written //in English//. There are [[CategoryCategory | other Categories]] available.
~ You can directly generate well-formatted documentation pages by "cloning" the [[http://docs.wikkawiki.org/DocumentationTemplate/clone | DocumentationTemplate]]
~
~-Do not create documentation entries for features/actions that are not yet included in the [[WikkaReleaseNotes | official Wikka releases]]
----
Deletions:
----
=====Documentation Guidelines=====
To preserve the overall consistency of documentation pages, please respect the following guidelines when creating/editing a documentation page.
~-When creating a new documentation entry, please check that another page on the same topic does not already exist
~-Documentation pages should be linked from the [[WikkaDocumentation | official Wikka Documentation page]]
~-Please add the following header and footer to every documentation page:
~ ---
~%%
[[WikkaDocumentation | Wikka Documentation]]
----
====Title of the page ====
Here goes page content
...
...
...
...
----
CategoryDocumentation
%%
~ You can directly generate well-formatted documentation pages by "cloning" the [[http://wikka.jsnx.com/DocumentationTemplate/clone | DocumentationTemplate]]
~
~-Do not create documentation entries for features/actions that are not yet included in the [[WikkaReleaseNotes | official Wikka releases]]
----
