Difference between revisions of "Wiki Guidelines"
(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…") |
(typo fixes) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
== Languages == | == Languages == | ||
| − | This is an international wiki. Please include this on every page you create: | + | This is in a sense an international wiki. Please include this on top of every page you create: |
| − | {{Codeline|<nowiki>{{i18n|TITLE}}</nowiki>}} | + | {{Codeline|<nowiki>{{i18n|TITLE}}</nowiki>}} |
| − | + | 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. | 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. | ||
| + | |||
| + | *Categories are not internationalized | ||
== Modules == | == Modules == | ||
| Line 13: | Line 15: | ||
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. | ||
Latest revision as of 16:33, 4 June 2012
Languages
This is in a sense an international wiki. Please include this on top of 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.
- Categories are not internationalized
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.
