Difference between revisions of "Wiki Guidelines"

From Ethersex_Wiki
Jump to: navigation, search
(Created page with "{{i18n|Wiki Guidelines}} == Languages == This is an international wiki. Please include this on every page you create: {{Codeline|<nowiki>{{i18n|TITLE}}</nowiki>}} replace TITL…")
 
Line 13: Line 13:
 
If you want to document a module, please make use of the [[Template:Module | Module Template]].
 
If you want to document a module, please make use of the [[Template:Module | Module Template]].
 
A well documented module should look similar to [[IRMP | this ]].
 
A well documented module should look similar to [[IRMP | this ]].
 +
 +
For the title, please use the name of the module in menuconfig or how it is called in the code (e.g. the folder name). Please do not chose a title that doesn't match with either one of these.
 +
 +
== More rules ==
 +
 +
* Refrain from putting all information related to a module into one single page. Create subpages for examples and specific setups.

Revision as of 18:04, 30 October 2011

Languages

This is an international wiki. Please include this on every page you create:

{{i18n|TITLE}}

replace TITLE with the title of the page you are editing. This will insert a language bar like the one you can see above. If you want to translate a page, simply click on the language and start editing. Make sure that you include the language template as well.

Modules

If you want to document a module, please make use of the Module Template. A well documented module should look similar to this .

For the title, please use the name of the module in menuconfig or how it is called in the code (e.g. the folder name). Please do not chose a title that doesn't match with either one of these.

More rules

  • Refrain from putting all information related to a module into one single page. Create subpages for examples and specific setups.