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

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

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

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

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

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

• Перво-наперво рекомендуем Вам ознакомиться с принципами форматирования текста в wiki-среде или с их кратким изложением.

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

Пример,

== Заголовок 1 ==
=== Заголовок 1.2 ===
== Заголовок 2 ==

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

Пример:

 function begin {} 

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

Пример:

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

Пример:

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

Пример:

==Сссылки==
http://www.samplelink#1.com/
http://www.samplelink#1.com/
...
http://www.samplelink#1.com/

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

Пример:

• Если в статье содержится, по меньшей мере, четыре раздела, то панель «Содержание» (с оглавлением статьи) автоматически появляется на странице, непосредственно перед первым заголовком (то есть сразу после вступительного раздела).

• • Если вы хотите, чтобы «Содержание» появилось в каком-либо другом месте статьи (а не там, где оно появляется по умолчанию), то поместите ключевое слово __TOC__ в этом месте. Если вы хотите, чтобы при этом «Содержание» появлялось сдвинутым к правому краю страницы, а текст слева обтекал содержание, то используйте шаблон {{TOCRight}} вместо ключевого слова __TOC__.

• • А для того, чтобы «Содержание» вообще нигде не появлялось, достаточно поместить ключевое слово __NOTOC__ где угодно на странице.

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

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

Пример:

Пример: