Help:Preparing reference information on SDK and MODs

From Mod Wiki

Revision as of 09:52, 8 June 2007

The main goal of this portal is collecting and structuring reference information on creating MODifications to the game S.T.A.L.K.E.R. Thus it's highly important to make all the documentation follow the singe style and be easy-to-interpret. If you're to one who wants to share knowledge with the community, the information below is just for you!

Adding new material

Make sure that there's no such article in our database; it's easy to do that using the Go search function. If no key words has been found, click on the "Create page" link.

Arranging principles

• First of all we recommend you to get acquainted with text formatting principles or with their brief overview.

• The article's text must be logically split into blocks using headings of various levels.

For example,

== Heading 1 ==
=== Heading 1.2 ===
== Heading 2 ==

• If your article is logically connected to the other one, please put the link to it in the beginning and in the end of your article.

Example:

• Put the pieces of the code into tags <pre>...</pre>.

Example:

 function begin {} 

• Put the names of the files (but not the whole paths) into the square brackets. This will create links to the resources in the knowledgebase with the same name even if there are no such articles at this moment. But they can appear later on!

Example:

• If you used someone's material in your article, please indicate that.

• The contents appear automatically after there has been more than 4 headings created in your article. If you want to use contents, add this marker to the article's text:

__TOC__

Commenting on the article

Please don't post questions or comments inside the article itself; use the "discussion" tab on the top of each article. Also, please specify that it was you who left a commentary. To do that, use markers that write in your login.

Example:

Example: