Справка:Оформление справочной информации по SDK или MOD'ам
Материал из Mod Wiki.
(Различия между версиями)
| Версия 07:05, 1 июня 2007 (править) Zergius (Обсуждение | вклад) ← К предыдущему изменению |
Версия 22:27, 1 июня 2007 (править) (отменить) Connect (Обсуждение | вклад) м (убрал клонированный текст) К следующему изменению → |
||
| Строка 12: | Строка 12: | ||
| Пример, | Пример, | ||
| <pre> | <pre> | ||
| - | <nowiki>== Заголовок 1 == | + | <nowiki>==</nowiki> Заголовок 1 <nowiki>==</nowiki> |
| - | === Заголовок 1.2 === | + | <nowiki>===</nowiki> Заголовок 1.2 <nowiki>===</nowiki> |
| - | == Заголовок 2 ==</nowiki> | + | <nowiki>==</nowiki> Заголовок 2 <nowiki>==</nowiki> |
| </pre> | </pre> | ||
| - | |||
| - | *Если Ваша статья имеет логическую связь с другой, укажите на нее ссылку в самом начале и после текста Вашей статьи. | ||
| - | {{sample|<nowiki>Навигация: [[Вводный курс]]</nowiki>|Навигация: [[Вводный курс]]}} | ||
| - | |||
| - | *Куски упоминаемого кода заключайте в теги <nowiki><pre>...</pre></nowiki>. | ||
| - | {{sample|<nowiki><pre></nowiki> '''function''' <nowiki>begin {} </pre></nowiki>|<pre> function begin {} </pre>}} | ||
| - | |||
| - | *Имена файлов (но не пути целиком) в тексте и термины, которые могут иметь дополнительные расширенные пояснения заключайте в двойные квадратные скобки. Это будет создавать ссылки на одноименные ресурсы в базе знаний даже если подобных статей на данный момент не существует. Они могут появиться позже! | ||
| - | {{sample|<code><nowiki>..\creatures\[[actor.ltx]]</nowiki></code>|..\creatures\[[actor.ltx]]}} | ||
| - | |||
| - | *Если Вы использовали в статье чей-то материал, укажите это. | ||
| - | |||
| - | *Содержание появляется автоматически после того, как в вашей статье будет указано более четырех заголовков. Если же, Вы хотите использовать содержание, добавьте в текст статьи маркер: | ||
| - | <nowiki>__TOC__</nowiki> | ||
| - | |||
| - | *Если Ваша статья имеет логическую связь с другой, укажите на нее ссылку в самом начале и после текста Вашей статьи. | ||
| - | {{sample|<nowiki>Навигация: [[Вводный курс]]</nowiki>|Навигация: [[Вводный курс]]}} | ||
| - | |||
| - | *Куски упоминаемого кода заключайте в теги <nowiki><pre>...</pre></nowiki>. | ||
| - | {{sample|<nowiki><pre></nowiki> '''function''' <nowiki>begin {} </pre></nowiki>|<pre> function begin {} </pre>}} | ||
| - | |||
| - | *Имена файлов (но не пути целиком) в тексте и термины, которые могут иметь дополнительные расширенные пояснения заключайте в двойные квадратные скобки. Это будет создавать ссылки на одноименные ресурсы в базе знаний даже если подобных статей на данный момент не существует. Они могут появиться позже! | ||
| - | {{sample|<code><nowiki>..\creatures\[[actor.ltx]]</nowiki></code>|..\creatures\[[actor.ltx]]}} | ||
| - | |||
| - | *Если Вы использовали в статье чей-то материал, укажите это. | ||
| - | |||
| - | *Содержание появляется автоматически после того, как в вашей статье будет указано более четырех заголовков. Если же, Вы хотите использовать содержание, добавьте в текст статьи маркер: | ||
| - | <nowiki>__TOC__</nowiki> | ||
| *Если Ваша статья имеет логическую связь с другой, укажите на нее ссылку в самом начале и после текста Вашей статьи. | *Если Ваша статья имеет логическую связь с другой, укажите на нее ссылку в самом начале и после текста Вашей статьи. | ||
Версия 22:27, 1 июня 2007
Основной целью данного портала является сбор и структурирование справочной информации по изготовлению модификаций к игре S.T.A.L.K.E.R. Поэтому очень важно, что бы вся документация была оформлена в едином стиле и легко читалась. Если Вы хотите поделиться с комьюнити своими знаниями, то приведенная ниже инструкция как раз для Вас!
Содержание |
Добавление нового материала
Убедитесь надлежайшим образом, что данной статьи еще не присутствует в нашей базе. Это легко сделать через функцию поиска "Перейти". Если ключевые слова не найдены, кликнете по ссылке "Создать страницу".
Принципы оформления
- Перво-наперво рекомендуем Вам ознакомиться с принципами форматирования текста в wiki-среде или с их кратким изложением.
- Текст статьи должен быть логическим образом разбит на блоки путем использования заголовков разных уровней.
Пример,
== Заголовок 1 == === Заголовок 1.2 === == Заголовок 2 ==
- Если Ваша статья имеет логическую связь с другой, укажите на нее ссылку в самом начале и после текста Вашей статьи.
Пример:
| как надо писать | как это выглядит |
| Навигация: [[Вводный курс]] | Навигация: Вводный курс |
- Куски упоминаемого кода заключайте в теги <pre>...</pre>.
Пример:
| как надо писать | как это выглядит |
| <pre> function begin {} </pre> | function begin {}
|
- Имена файлов (но не пути целиком) в тексте и термины, которые могут иметь дополнительные расширенные пояснения заключайте в двойные квадратные скобки. Это будет создавать ссылки на одноименные ресурсы в базе знаний даже если подобных статей на данный момент не существует. Они могут появиться позже!
Пример:
| как надо писать | как это выглядит |
..\creatures\[[actor.ltx]]
| ..\creatures\actor.ltx |
- Если Вы использовали в статье чей-то материал, укажите это.
- Содержание появляется автоматически после того, как в вашей статье будет указано более четырех заголовков. Если же, Вы хотите использовать содержание, добавьте в текст статьи маркер:
__TOC__
Комментирование статьи
Убедительная просьба не размещать вопросы или какие-либо замечания в самой статье, если вы не хотите сами ее исправить. Воспользуйтесь закладкой "Обсуждение", которая имеется у каждой статьи. Так же, оставляя комментарии, указывайте, что это сделали именно Вы. Для этого воспользуйтесь маркерами, подставляющими Ваш логин.
Пример:
| как надо писать | как это выглядит |
~~~
| Connect |
Пример:
| как надо писать | как это выглядит |
~~~~
| Connect 10:54, 30 мая 2007 (EEST) |
