Help:Preparing reference information on SDK and MODs

From Mod Wiki

Revision as of 15:31, 14 July 2008 (edit) Don Reba (Talk | contribs) (→Adding new material) ← Previous diff		Current revision (16:28, 14 July 2008) (edit) (undo) Don Reba (Talk | contribs) (removed formatting help; linked to formatting help)
Line 1:		Line 1:
	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!		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!
-	__TOC__
	==Adding new material==		==Adding new material==
Line 8:		Line 7:
	[[Image:Create_wiki_page.png|center|thumb]]		[[Image:Create_wiki_page.png|center|thumb]]
-	==Arranging principles==	+	==Commenting on an article==
-	*First of all we recommend you to get acquainted with [[Mod Wiki:Editing note|text formatting principles]] or with their [[Help:Wiki format brief overview|brief overview]].	+
-		+
-	*The article's text must be logically split into blocks using headings of various levels.	+
-	For example,	+
-	<pre>	+
-	<nowiki>== Heading 1 ==	+
-	=== Heading 1.2 ===	+
-	== Heading 2 ==</nowiki>	+
-	</pre>	+
-		+
-	*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.	+
-	{{sample|<nowiki>Navigation: [[Help:Introductory course|Introductory course]]</nowiki>|Navigation: [[Help:Introductory course|Introductory course]]}}	+
-		+
-	*Put the pieces of the code into tags <nowiki><pre>...</pre></nowiki>.	+
-	{{sample|<nowiki><pre></nowiki> '''function''' <nowiki>begin {} </pre></nowiki>|<pre> function begin {} </pre>}}	+
-		+
-	*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!	+
-	{{sample|<code><nowiki>..\creatures\[[actor.ltx]]</nowiki></code>|..\creatures\[[actor.ltx]]}}	+
-		+
-	*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:	+
-	<nowiki>__TOC__</nowiki>	+
-		+
-	==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.		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.
	{{sample|<code><nowiki>~~~</nowiki></code>|[[Member:Connect|Connect]]}}		{{sample|<code><nowiki>~~~</nowiki></code>|[[Member:Connect|Connect]]}}
	{{sample|<code><nowiki>~~~~</nowiki></code>|[[Member:Connect|Connect]] 10:54, May 10, 2007 (EEST)}}		{{sample|<code><nowiki>~~~~</nowiki></code>|[[Member:Connect|Connect]] 10:54, May 10, 2007 (EEST)}}
		+
		+	== See also ==
		+	* [[Help:Wiki format brief overview]]
	[[Category:Web-site_directory|{{PAGENAME}}]]		[[Category:Web-site_directory|{{PAGENAME}}]]
	[[ru:Справка:Оформление справочной информации по SDK или MOD'ам]]		[[ru:Справка:Оформление справочной информации по SDK или MOD'ам]]

---

Current revision

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. Use sentence case for article names, capitalizing only the first word and proper nouns.

Commenting on an 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:

how to write	how it looks
~~~	Connect

Example:

how to write	how it looks
~~~~	Connect 10:54, May 10, 2007 (EEST)

See also

• Help:Wiki format brief overview