Help:Preparing reference information on SDK and MODs
From Mod Wiki
(Difference between revisions)
| Revision as of 15:06, 5 June 2007 (edit) Zergius (Talk | contribs) ← Previous diff |
Revision as of 16:18, 7 June 2007 (edit) (undo) Smile (Talk | contribs) Next diff → |
||
| 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! | |
| __TOC__ | __TOC__ | ||
| - | == | + | ==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 [[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> | <pre> | ||
| - | <nowiki>== | + | <nowiki>== Heading 1 == |
| - | === | + | === Heading 1.2 === |
| - | == | + | == Heading 2 ==</nowiki> |
| </pre> | </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> | + | {{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>}} | {{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]]}} | {{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> | <nowiki>__TOC__</nowiki> | ||
| - | + | ==Commenting the article== | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | == | + | |
| Убедительная просьба не размещать вопросы или какие-либо замечания в самой статье, если вы не хотите сами ее исправить. Воспользуйтесь закладкой "Обсуждение", которая имеется у каждой статьи. Так же, оставляя комментарии, указывайте, что это сделали именно Вы. Для этого воспользуйтесь маркерами, подставляющими Ваш логин. | Убедительная просьба не размещать вопросы или какие-либо замечания в самой статье, если вы не хотите сами ее исправить. Воспользуйтесь закладкой "Обсуждение", которая имеется у каждой статьи. Так же, оставляя комментарии, указывайте, что это сделали именно Вы. Для этого воспользуйтесь маркерами, подставляющими Ваш логин. | ||
Revision as of 16:18, 7 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!
Contents |
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:
| how to write | how it looks |
| Navigation: [[Help:Introductory course|Introductory course]] | Navigation: Introductory course |
- Put the pieces of the code into tags <pre>...</pre>.
Example:
| how to write | how it looks |
| <pre> function begin {} </pre> | 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:
| how to write | how it looks |
..\creatures\[[actor.ltx]]
| ..\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:
__TOC__
Commenting the article
Убедительная просьба не размещать вопросы или какие-либо замечания в самой статье, если вы не хотите сами ее исправить. Воспользуйтесь закладкой "Обсуждение", которая имеется у каждой статьи. Так же, оставляя комментарии, указывайте, что это сделали именно Вы. Для этого воспользуйтесь маркерами, подставляющими Ваш логин.
Example:
| how to write | how it looks |
~~~
| Connect |
Example:
| how to write | how it looks |
~~~~
| Connect 10:54, 30 мая 2007 (EEST) |
