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

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

Версия 23:39, 31 мая 2007

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

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

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

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

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

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

Пример,

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

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

Пример:

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

Пример:

 function begin {} 

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

Пример:

• Если Вы использовали в статье чей-то материал, укажите это.

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

__TOC__

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

Пример:

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

Пример:

 function begin {} 

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

Пример:

• Если Вы использовали в статье чей-то материал, укажите это.

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

__TOC__

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

Пример:

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

Пример:

 function begin {} 

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

Пример:

• Если Вы использовали в статье чей-то материал, укажите это.

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

__TOC__

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

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

Пример:

Пример: