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

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

(Различия между версиями)
Перейти к: навигация, поиск
Версия 23:28, 31 мая 2007 (править)
Roma (Обсуждение | вклад)
м Оформление справочной информации» переименована в «Справка:Оформление справочной информации по SDK или MOD'ам»)
← К предыдущему изменению
Текущая версия (17:37, 3 июня 2007) (править) (отменить)
Roma (Обсуждение | вклад)

 
(9 промежуточных версий не показаны.)
Строка 1: Строка 1:
-<!---->+Основной целью данного портала является сбор и структурирование справочной информации по изготовлению модификаций к игре S.T.A.L.K.E.R. Поэтому очень важно, что бы вся документация была оформлена в едином стиле и легко читалась. Если Вы хотите поделиться с комьюнити своими знаниями, то приведенная ниже инструкция как раз для Вас!
- Навигация: [[Вводный курс]]+ 
-{|+
-| [[Изображение:Icon_help.png]] ||+
-|Основной целью данного портала является сбор и структурирование справочной информации по изготовлению модификаций к игре S.T.A.L.K.E.R. Поэтому очень важно, что бы вся документация была оформлена в едином стиле и легко читалась. Если Вы хотите поделиться с комьюнити своими знаниями, то приведенная ниже инструкция как раз для Вас!+
-|}+
__TOC__ __TOC__
-==Добавление нового материала ==+==Добавление нового материала==
-Убедитесь надлежайшим образом, что данной статьи еще не присутствует в нашей базе. Это легко сделать через функцию поиска "Перейти". Если ключевые слова не найдены, кликнете по ссылке "Создать страницу".+Убедитесь надлежайшим образом, что данной статьи еще не присутствует в нашей базе. Это легко сделать через функцию поиска '''"Перейти"''' или '''"Найти"'''. Если ключевые слова не найдены, кликните по ссылке '''"Создать страницу"'''.
==Принципы оформления== ==Принципы оформления==
-*Перво-наперво рекомендуем Вам ознакомиться с [[Mod_Wiki:Справка по редактированию|принципами форматирования текста в wiki-среде]] или с их [[Краткий курс формата wiki|кратким изложением]].+*Перво-наперво рекомендуем Вам ознакомиться с [[Help:Справка по редактированию|принципами форматирования текста в wiki-среде]] или с их [[Справка:Краткий курс формата MediaWiki|кратким изложением]].
*Текст статьи должен быть логическим образом разбит на блоки путем использования заголовков разных уровней. *Текст статьи должен быть логическим образом разбит на блоки путем использования заголовков разных уровней.
Пример, Пример,
<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>|Навигация: [[Вводный курс]]}} {{sample|<nowiki>Навигация: [[Вводный курс]]</nowiki>|Навигация: [[Вводный курс]]}}
- +-->
-*Куски упоминаемого кода заключайте в теги <nowiki><pre>...</pre></nowiki>.+*Куски упоминаемого кода заключайте в теги '''<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>}}
Строка 30: Строка 26:
{{sample|<code><nowiki>..\creatures\[[actor.ltx]]</nowiki></code>|..\creatures\[[actor.ltx]]}} {{sample|<code><nowiki>..\creatures\[[actor.ltx]]</nowiki></code>|..\creatures\[[actor.ltx]]}}
-*Если Вы использовали в статье чей-то материал, укажите это. +*Если Вы использовали в статье чей-то материал, укажите это используя шаблон '''<nowiki>{{ref}}</nowiki>'''.
-*Содержание появляется автоматически после того, как в вашей статье будет указано более четырех заголовков. Если же, Вы хотите использовать содержание, добавьте в текст статьи маркер:+{{Sample
- <nowiki>__TOC__</nowiki>+|1='''<nowiki>{{ref|src=<<название источника>>|link=<<http://www.samplelink.com/>>}}</nowiki>'''
 +|2={{ref|src=<<название источника>>|link=http://www.samplelink.com/}}
 +}}
-*Если Ваша статья имеет логическую связь с другой, укажите на нее ссылку в самом начале и после текста Вашей статьи.+Или добавьте в конце статьи раздел '''Cсылки''':
-{{sample|<nowiki>Навигация: [[Вводный курс]]</nowiki>|Навигация: [[Вводный курс]]}}+
-*Куски упоминаемого кода заключайте в теги <nowiki><pre>...</pre></nowiki>.+{{Sample
-{{sample|<nowiki><pre></nowiki> '''function''' <nowiki>begin {} </pre></nowiki>|<pre> function begin {} </pre>}}+|1=<pre>==Сссылки==
 +http://www.samplelink#1.com/
 +http://www.samplelink#1.com/
 +...
 +http://www.samplelink#1.com/
 +</pre>
 +|2=
 +<div style="color: black; background: none; font-weight: normal; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa; font-size: 150%">Ссылки</div>
 +http://www.samplelink#1.com/
-*Имена файлов (но не пути целиком) в тексте и термины, которые могут иметь дополнительные расширенные пояснения заключайте в двойные квадратные скобки. Это будет создавать ссылки на одноименные ресурсы в базе знаний даже если подобных статей на данный момент не существует. Они могут появиться позже!+http://www.samplelink#2.com/
-{{sample|<code><nowiki>..\creatures\[[actor.ltx]]</nowiki></code>|..\creatures\[[actor.ltx]]}}+
-*Если Вы использовали в статье чей-то материал, укажите это. +...
-*Содержание появляется автоматически после того, как в вашей статье будет указано более четырех заголовков. Если же, Вы хотите использовать содержание, добавьте в текст статьи маркер:+http://www.samplelink#n.com/
- <nowiki>__TOC__</nowiki>+}}
-*Если Ваша статья имеет логическую связь с другой, укажите на нее ссылку в самом начале и после текста Вашей статьи. 
-{{sample|<nowiki>Навигация: [[Вводный курс]]</nowiki>|Навигация: [[Вводный курс]]}} 
-*Куски упоминаемого кода заключайте в теги <nowiki><pre>...</pre></nowiki>.+*В конце статьи указывайте категории, к которым она относится.
-{{sample|<nowiki><pre></nowiki> '''function''' <nowiki>begin {} </pre></nowiki>|<pre> function begin {} </pre>}}+ 
 +{{Sample
 +|1=<nowiki>[[Категория:Скрипты]]</nowiki>
 + 
 +''или''
-*Имена файлов (но не пути целиком) в тексте и термины, которые могут иметь дополнительные расширенные пояснения заключайте в двойные квадратные скобки. Это будет создавать ссылки на одноименные ресурсы в базе знаний даже если подобных статей на данный момент не существует. Они могут появиться позже!+<nowiki>[[Категория:Предметы]]</nowiki>
-{{sample|<code><nowiki>..\creatures\[[actor.ltx]]</nowiki></code>|..\creatures\[[actor.ltx]]}}+ 
 +''или''
 + 
 +<nowiki>[[Категория:Оружие]]</nowiki>
 +|2=<div style="border: 1px solid #aaa; background-color: #f9f9f9; padding: 5px; clear: both;">Категория:Скрипты</div>
 +<div style="border: 1px solid #aaa; background-color: #f9f9f9; padding: 5px; margin-top: 1.2em; clear: both;">Категория:Предметы</div>
 +<div style="border: 1px solid #aaa; background-color: #f9f9f9; padding: 5px; margin-top: 1.2em; clear: both;">Категория:Оружие</div>
 +}}
 + 
 +*Если в статье содержится, по меньшей мере, четыре раздела, то панель «Содержание» (с оглавлением статьи) автоматически появляется на странице, непосредственно перед первым заголовком (то есть сразу после вступительного раздела).
 + 
 +** Если вы хотите, чтобы «Содержание» появилось в каком-либо другом месте статьи (а не там, где оно появляется по умолчанию), то поместите ключевое слово '''<nowiki>__TOC__</nowiki>''' в этом месте. Если вы хотите, чтобы при этом «Содержание» появлялось сдвинутым к правому краю страницы, а текст слева обтекал содержание, то используйте шаблон '''<nowiki>{{TOCRight}}</nowiki>''' вместо ключевого слова '''<nowiki>__TOC__</nowiki>'''.
-*Если Вы использовали в статье чей-то материал, укажите это. +** А для того, чтобы «Содержание» вообще нигде не появлялось, достаточно поместить ключевое слово '''<nowiki>__NOTOC__</nowiki>''' где угодно на странице.
-*Содержание появляется автоматически после того, как в вашей статье будет указано более четырех заголовков. Если же, Вы хотите использовать содержание, добавьте в текст статьи маркер: 
- <nowiki>__TOC__</nowiki> 
==Комментирование статьи== ==Комментирование статьи==
Строка 69: Строка 84:
{{sample|<code><nowiki>~~~~</nowiki></code>|[[Участник:Connect|Connect]] 10:54, 30 мая 2007 (EEST)}} {{sample|<code><nowiki>~~~~</nowiki></code>|[[Участник:Connect|Connect]] 10:54, 30 мая 2007 (EEST)}}
- Навигация: [[Вводный курс]]+[[Category:Справка по сайту|{{PAGENAME}}]]
-[[en:Preparing reference information]]+[[en:Help:Preparing reference information]]

Текущая версия

Основной целью данного портала является сбор и структурирование справочной информации по изготовлению модификаций к игре 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__ в этом месте. Если вы хотите, чтобы при этом «Содержание» появлялось сдвинутым к правому краю страницы, а текст слева обтекал содержание, то используйте шаблон {{TOCRight}} вместо ключевого слова __TOC__.
    • А для того, чтобы «Содержание» вообще нигде не появлялось, достаточно поместить ключевое слово __NOTOC__ где угодно на странице.


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

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

Пример:

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

Пример:

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