This wiki is out of date, use the continuation of this wiki instead

Standards

From FenixWiki

(Difference between revisions)
Jump to: navigation, search
Revision as of 11:02, 23 March 2007 (edit)
FCR (Talk | contribs)
(Definition)
← Previous diff
Current revision (12:31, 21 January 2008) (edit) (undo)
Sandman (Talk | contribs)
m
 
(14 intermediate revisions not shown.)
Line 1: Line 1:
-You do not have to feel obligated, but please try to keep your article according to following standards, so that we can get a homogenic look.+You do not have to feel obligated, but please try to keep your article according to following standards, so that we can get a homogenic look. The standards are quite natural and will appear logical when followed. Different sections contain different information; below are three general section which are mostly used.
-== Definition ==+Also look at these:
-This is the name of the [[function]], [[process]], [[variable]], ... , and also the name of the article.+* [[Standards:function]]
-This block also contains the parameters (the article name doesn't) and return type. You do not need to add the title "definition" you can simply place it on top of the article.+* [[Standards:variable]]
 +* [[Standards:names]]
-Below is some general information such as what the function's or variable's purpose, or a specific [[dll]] you need...+Note that in practice you don't need to look at these standards. Just copy the wikicode of the [[function example]] or [[variable_example]] and edit its content. When you are unsure about something, you can always refer to it.
-== Parameters ==+== Definition ==
- +This is the name of the [[function]], [[process]], [[variable]], ... , and also, probably, the name of the article. Before the name is the [[datatype]] of the variable or of what the function returns.
-These are the [[parameter|parameters]] explained+
-== Example == +Here is some general information such as what the function's or variable's purpose, or a specific [[dll]] you need. Notice the white line, indicating a sort of separate section.
-A simple example using the function (between <pre> tags). Please do not use links in your code. Refer to the keywords beneath the code in a list. only include relevant keywords. i.e. Do not link to every possible reserved word (as seen in the example code below).+== Notes ==
 +Some more in depth information about the subject, if needed. The kind of information not needed for normal use, but more like "doing it like so is bad or doing it like that is good".
-<pre>+== Example ==
- Program test;+A simple example using the function (between &lt;pre&gt; tags). Please do not use links in your code, but refer to the keywords beneath the code in a list, if needed. Only include relevant keywords, i.e. do not link to every possible reserved word. The example doesn't have to be advanced or big, on the contrary, simple examples are better.
- Begin+
- Loop+
- frame;+
- End+
- End+
-</pre>+

Current revision

You do not have to feel obligated, but please try to keep your article according to following standards, so that we can get a homogenic look. The standards are quite natural and will appear logical when followed. Different sections contain different information; below are three general section which are mostly used.

Also look at these:

Note that in practice you don't need to look at these standards. Just copy the wikicode of the function example or variable_example and edit its content. When you are unsure about something, you can always refer to it.

Definition

This is the name of the function, process, variable, ... , and also, probably, the name of the article. Before the name is the datatype of the variable or of what the function returns.

Here is some general information such as what the function's or variable's purpose, or a specific dll you need. Notice the white line, indicating a sort of separate section.

Notes

Some more in depth information about the subject, if needed. The kind of information not needed for normal use, but more like "doing it like so is bad or doing it like that is good".

Example

A simple example using the function (between <pre> tags). Please do not use links in your code, but refer to the keywords beneath the code in a list, if needed. Only include relevant keywords, i.e. do not link to every possible reserved word. The example doesn't have to be advanced or big, on the contrary, simple examples are better.

Personal tools