Справка:Оформление справочной информации по SDK или MOD'ам

Материал из Mod Wiki.

(Различия между версиями)
Перейти к: навигация, поиск
Версия 17:12, 3 июня 2007 (править)
Roma (Обсуждение | вклад)

← К предыдущему изменению
Версия 17:12, 3 июня 2007 (править) (отменить)
Roma (Обсуждение | вклад)

К следующему изменению →
Строка 74: Строка 74:
{{Sample {{Sample
|<nowiki>__TOC__</nowiki> |<nowiki>__TOC__</nowiki>
-|__TOC__+|2=__TOC__
}} }}
Или вы можете воспользоваться шаблоном '''<nowiki>{{TOCRight}}</nowiki>''', если хотите чтобы содержание отображалось справа. Или вы можете воспользоваться шаблоном '''<nowiki>{{TOCRight}}</nowiki>''', если хотите чтобы содержание отображалось справа.
{{Sample {{Sample
|'''<nowiki>{{TOCRight}}</nowiki>''' |'''<nowiki>{{TOCRight}}</nowiki>'''
-|{{TOCRight}}+|2={{TOCRight}}
}} }}

Версия 17:12, 3 июня 2007

Основной целью данного портала является сбор и структурирование справочной информации по изготовлению модификаций к игре S.T.A.L.K.E.R. Поэтому очень важно, что бы вся документация была оформлена в едином стиле и легко читалась. Если Вы хотите поделиться с комьюнити своими знаниями, то приведенная ниже инструкция как раз для Вас!

Содержание

Добавление нового материала

Убедитесь надлежайшим образом, что данной статьи еще не присутствует в нашей базе. Это легко сделать через функцию поиска "Перейти". Если ключевые слова не найдены, кликнете по ссылке "Создать страницу".

Принципы оформления

  • Текст статьи должен быть логическим образом разбит на блоки путем использования заголовков разных уровней.

Пример,

== Заголовок 1 ==
=== Заголовок 1.2 ===
== Заголовок 2 ==
  • Куски упоминаемого кода заключайте в теги <pre>...</pre>.

Пример:

как надо писать как это выглядит
<pre> function begin {} </pre>
 function begin {} 


  • Имена файлов (но не пути целиком) в тексте и термины, которые могут иметь дополнительные расширенные пояснения заключайте в двойные квадратные скобки. Это будет создавать ссылки на одноименные ресурсы в базе знаний даже если подобных статей на данный момент не существует. Они могут появиться позже!

Пример:

как надо писать как это выглядит
..\creatures\[[actor.ltx]] ..\creatures\actor.ltx


  • Если Вы использовали в статье чей-то материал, укажите это используя шаблон {{ref}}.

Пример:

как надо писать как это выглядит
{{ref|src=<<название источника>>|link=<<http://www.samplelink.com/>>}} (ист.)


Или добавьте в конце статьи раздел Cсылки:

Пример:

как надо писать как это выглядит
==Сссылки==
http://www.samplelink#1.com/
http://www.samplelink#1.com/
...
http://www.samplelink#1.com/
Ссылки

http://www.samplelink#1.com/

http://www.samplelink#2.com/

...

http://www.samplelink#n.com/


  • В конце статьи указывайте категории, к которым она относится.

Пример:

как надо писать как это выглядит
[[Категория:Скрипты]]

или

[[Категория:Предметы]]

или

[[Категория:Оружие]]

Категория:Скрипты
Категория:Предметы
Категория:Оружие


  • Содержание появляется автоматически после того, как в вашей статье будет указано более четырех заголовков. Если же, Вы хотите использовать содержание, добавьте в текст статьи маркер __TOC__:

Пример:

как надо писать как это выглядит
__TOC__

Или вы можете воспользоваться шаблоном {{TOCRight}}, если хотите чтобы содержание отображалось справа. Пример:

как надо писать как это выглядит
{{TOCRight}} {| align="right" cellspacing="0" cellpadding="0" style="clear:right; margin-bottom: .5em; float: right; padding: .5em 0 .8em 1.4em; background: none;"
|}


Комментирование статьи

Убедительная просьба не размещать вопросы или какие-либо замечания в самой статье, если вы не хотите сами ее исправить. Воспользуйтесь закладкой "Обсуждение", которая имеется у каждой статьи. Так же, оставляя комментарии, указывайте, что это сделали именно Вы. Для этого воспользуйтесь маркерами, подставляющими Ваш логин.

Пример:

как надо писать как это выглядит
~~~ Connect

Пример:

как надо писать как это выглядит
~~~~ Connect 10:54, 30 мая 2007 (EEST)
Личные инструменты
На других языках