Module documentation

From MapbenderWiki

Contents 1 source code 2 wiki 2.1 Example 2.2 add a module maintainer 2.3 add category 2.4 use this template

source code

See NaturalDocs for JS documentation templates.

wiki

Example

Add WMS from tree

add a module maintainer

• See Module maintainer. Whenever you edit a piece of code and you are the originator (Urheber), go to the corresponding Wiki page and add your Wiki user name as a link. Also consider adding the page to your watchlist.

Example:

[[User:Foo Hacker]] ([[Module maintainer]])

• Whenever you edit a piece of code that has been abandoned by the originator (no alive user link there, coder has left altogether, whatever) you can take over responsibilities by adding your Wiki user name.

Example:

[[User:Foo Hacker]]

• The originator and major contributors of the code should also always be kept on that page, so do not delete the names but simply remove the square brackets around User:Foo Hacker and only leave "Foo Hacker".

Example:

User:Foo Hacker

add category

for example by adding

[[Category:Modules]]
[[Category:Internationalized]] --> if your module provides i18n

use this template

[[User:Foo Maintainer]] ([[Module maintainer]]) OR [[Modules_without_maintainer | ''no maintainer'']]

[[User:Foo Contributor1]]

[[User:Foo Contributor2]]
.
.
.

<version, for example Mapbender >= 2.7>

== API ==
[example:https://svn.osgeo.org/mapbender/trunk/mapbender/documents/api_js/files/http/javascripts/mod_addWMSfromTree-js.html technical documentation]

== english==
=== user story ===
=== usage ===
<with screenshots!>

== deutsch ==
=== Funktionsumfang ===
=== Gebrauchsanweisung ===
<mit Screenshots!>

</textarea></html>
 

[[Category:Modules]]