Руководство по наполнению вики: различия между версиями

Нет описания правки
(Убрал упоминания форума оффов)
Строка 12: Строка 12:
=== Начало работы ===
=== Начало работы ===


Вам нужно будет '''привязать свой аккаунт byond к вашему аккаунту на форуме''', чтобы иметь возможность редактировать вики. Инструкции можно найти [https://tgstation13.org/phpBB/linkbyondaccount.php здесь]. Вкратце:
Вам нужно будет '''создать новый аккаунт на нашей википедии''', чтобы иметь возможность редактировать её. Сделать это можно, нажав на иконку человека в правой верхней части экрана.
# Создайте аккаунт Byond (если у вас его ещё нет).
# Создайте аккаунт на форуме tgstation13.
# Свяжите эти учётные записи. Существует несколько способов связать учётные записи:
## Подключитесь к обычному серверу /tg/ и нажмите кнопку «Связать учётную запись форума» на вкладке OOC.
## Присоединитесь к выделенному серверу Byond для связи учётных записей: byond://byondoauth.tgstation13.org:31337
## <span style=color:red>(Экспериментальный/с ошибками)</span> Используйте ссылку https://tgstation13.org/phpBB/linkbyondaccount.php?go=1&


Теперь вы сможете увидеть кнопки «Править» на вики.
Теперь вы сможете начать вносить изменения в незащищённые страницы.


===  Важные замечания  ===
===  Важные замечания  ===
Строка 34: Строка 28:
== Что нужно сделать? ==
== Что нужно сделать? ==


Список дел для вики находится на форумах /tg/ и доступен [https://tgstation13.org/phpBB/viewtopic.php?f=45&t=30266 здесь].
Список дел для вики находится в дискорде нашего проекта и у ведущего вики редактора.


=== Новые страницы ===
=== Новые страницы ===
Строка 73: Строка 67:
'''ВАЖНЫЕ ЗАМЕЧАНИЯ:''' Изображения можно обновлять только файлами того же формата: изображения .png нельзя обновить до .gif и наоборот. Это связано с тем, что файлы сохраняются на странице, в названии которой указан их формат. Из-за проблем с кешированием обновление существующих изображений может занять до недели.
'''ВАЖНЫЕ ЗАМЕЧАНИЯ:''' Изображения можно обновлять только файлами того же формата: изображения .png нельзя обновить до .gif и наоборот. Это связано с тем, что файлы сохраняются на странице, в названии которой указан их формат. Из-за проблем с кешированием обновление существующих изображений может занять до недели.
=== Вкладки ===
=== Вкладки ===
На любую страницу можно добавить вкладки с помощью функции <code><nowiki><tabs></nowiki></code>. Эта функция имеет известную проблему: она отображается правильно в режиме предварительного просмотра редактирования страницы, но неправильно после применения правки. Чтобы это исправить, необходимо очистить кеш страницы. Один простой способ — добавить '''?action=purge''' в конце URL-адреса страницы. Если проблема не исчезнет, оставьте сообщение [https://tgstation13.org/phpBB/viewforum.php?f=45| на форуме].
На любую страницу можно добавить вкладки с помощью функции <code><nowiki><tabs></nowiki></code>. Эта функция имеет известную проблему: она отображается правильно в режиме предварительного просмотра редактирования страницы, но неправильно после применения правки. Чтобы это исправить, необходимо очистить кеш страницы. Один простой способ — добавить '''?action=purge''' в конце URL-адреса страницы.


== Руководство по написанию и редактированию руководства ==
== Руководство по написанию и редактированию руководства ==

Версия от 11:44, 22 августа 2024

Pinpointer.gifМожет содержать ошибкиPinpointer.gif
Эта недавно переведённая статья может содержать грамматические или логические ошибки. Если вы заметите их при чтении текста, просьба внести правки, нажав кнопку "Править". Если вы не уверены в корректности перевода, сверьтесь с оригинальным текстом на старой версии страницы. Вместе мы справимся!

Добро пожаловать

Мы рады, что вы проявили интерес к наполнению вики. Мы приветствуем всех редакторов и исходим из презумпции добросовестности для всех правок, поэтому у нас очень мало защищённых страниц. Не бойтесь действовать и начинайте создавать и изменять страницы.

Начало работы

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

Теперь вы сможете начать вносить изменения в незащищённые страницы.

Важные замечания

  • Пожалуйста, кратко описывайте свои правки. При редактировании вы увидите текстовое поле для краткого описания рядом с кнопкой «Сохранить страницу». Оно добавляет ясности и подробностей в историю страницы и журнал свежих изменений.
  • Редактирование любой страницы со вкладками может потребовать ручной очистки кеша страницы. Подробнее см. Вкладки
  • Вики, по большей части, должна быть ориентирована на новых игроков. Если вы ветеран и хотите поделиться более продвинутыми советами и тактиками, пожалуйста, чётко отделите их от остального контента. Например, создайте новый заголовок «Продвинутый (тема)»
  • Кнопка «Править» использует визуальный редактор Mediawiki, который предоставляет удобный интерфейс для пользователей, которые могут быть менее опытны в викикоде. Кнопка «Править код» использует старомодный, но универсальный редактор исходного кода.

Викикод

Викикод — это необычный синтаксис, используемый во всех вики, включая эту. Наша страница викикод содержит хорошие примеры того, как вставлять заголовки, шаблоны, таблицы, Изображения, и многое другое. Если у нас нет того, что вы ищете, попробуйте страницу Википедии здесь. Изучение разметки вики не является обязательным, вы можете помочь, даже не используя её.

Что нужно сделать?

Список дел для вики находится в дискорде нашего проекта и у ведущего вики редактора.

Новые страницы

В /tg/station 13 постоянно добавляется новый контент, для которого нужны руководства и документация. Прежде чем создавать новую страницу, убедитесь, что её ещё нет. Мы приветствуем любые материалы для вики и верим, что все правки делаются из благих побуждений. В качестве рекомендации, если вы хотите работать над страницей без перерывов и не беспокоиться о правках других пользователей во время работы, делайте это в своей личной песочнице или где-нибудь на своих собственных страницах. Если вы не знаете викикода, вы можете создать неформатированную страницу и попросить кого-нибудь другого отформатировать её за вас.

Существующие страницы

Список страниц, требующих доработки, можно найти здесь.

Обновления выходят часто, и нам нужны люди, которые будут обновлять информацию в вики. Для этого просто отредактируйте страницу, добавив новую информацию. Если вы не знаете викикода, вы можете написать новый и/или обновлённый контент на странице обсуждения без форматирования.

Отметка для доработки и удаления

Если страница устарела или у неё нет причин для существования, добавьте один из следующих тегов в начало страницы:

{{Needs revision}}
{{Needs revision | reason = Устарела.}}
или
{{delete}}

Изображения

Загрузка новых изображений

Если у вас есть новые и актуальные изображения, загрузите их и добавьте на страницу, для которой они предназначены. Будем благодарны, если изображения предметов, которые вы добавляете, будут иметь прозрачный фон и формат .gif или .png. Самый простой способ добавить изображения предметов — загрузить исходный код, открыть файлы значков .dmi и экспортировать изображения в формате .gif или .png оттуда.

Затем загрузите их сюда: https://tgstation13.org/wiki/Special:Upload

Обновление существующих изображений

Изображение может устареть после обновления исходного кода. Чтобы обновить существующее устаревшее изображение, вы можете:

  • Перейти на страницу загрузки и загрузить новое изображение с тем же путём к файлу, что и у старого изображения.
  • Перейти на его страницу в вики (щёлкнув само изображение или выполнив поиск по его имени, используя префикс «Файл:» в строке поиска), щёлкнуть «Загрузить новую версию этого файла» в разделе «История файла» и выбрать новое изображение на странице загрузки.

Все устаревшие версии изображения останутся на странице истории файла для потомков.

ВАЖНЫЕ ЗАМЕЧАНИЯ: Изображения можно обновлять только файлами того же формата: изображения .png нельзя обновить до .gif и наоборот. Это связано с тем, что файлы сохраняются на странице, в названии которой указан их формат. Из-за проблем с кешированием обновление существующих изображений может занять до недели.

Вкладки

На любую страницу можно добавить вкладки с помощью функции <tabs>. Эта функция имеет известную проблему: она отображается правильно в режиме предварительного просмотра редактирования страницы, но неправильно после применения правки. Чтобы это исправить, необходимо очистить кеш страницы. Один простой способ — добавить ?action=purge в конце URL-адреса страницы.

Руководство по написанию и редактированию руководства

Всегда помните, для чего нужны эти руководства; они нужны для того, чтобы новички могли быстро просмотреть их и получить представление о том, что они только что выбрали.

Хорошее руководство должно содержать, по порядку:

  • Краткое описание режима в одном-двух абзацах.
  • Список из коротких, чётких и лаконичных пунктов, описывающих ключевые механики; каждый пункт должен быть не длиннее двух предложений. И помните: ключевые моменты — это то, что вам нужно знать, чтобы соответствовать минимальным ожиданиям в начале раунда. Вы должны быть в состоянии прочитать и понять его в течение 5 минут.
  • Более подробный раздел, описывающий механику игры. Он включает в себя более сложную информацию, но она всё равно должна быть чёткой и лаконичной.
  • Краткое изложение основных моментов; да — одно в начале и одно в конце. Повторение помогает лучше запомнить материал. Это будет, по сути, простой список, напоминающий читателю о важных деталях, а не объясняющий их.
  • Дополнительная литература — здесь читатель может получить более подробную и расширенную информацию или стратегии. Если она должна быть написана на главной странице, чётко отделите её от остального контента, например, новым заголовком. В противном случае перечислите соответствующие статьи, чтобы пользователи могли погрузиться в кроличью нору!
  • Гиперссылки! Не забудьте добавить ссылки на режимы игры, aроли антагонистов, профессии, предметы и руководства о которых вы упомянули! Лучше делать это на этапе корректуры, чтобы не тратить время при написании самой статьи.

Примером плохого руководства будет огромная стена текста, которая содержит слишком много воды и/или полна неинформативных мнений.
Это отпугнёт как новых, так и опытных игроков. Старайтесь не перегружать и не пугать новичков.

Итак, помните:

  • Факты — это хорошо, мнения — плохо.
  • Излагайте факты чётко, без лишней воды.
  • Основы должны быть простыми, а более сложная информация — в отдельном разделе или на отдельной странице.
  • Важная информация в первую очередь, подробности, объяснения и несущественные вещи — потом.
  • Пробелы, таблицы, разделы и форматирование имеют важное значение для удобства чтения. Мы не печатное издание, место не ограничено, поэтому используйте его свободно.
  • Ссылки!
  • Я только что использовал вышеприведённый шаблон, чтобы написать это руководство.

Шутки

Некоторые отсылки (и даже целые страницы) предназначены для развлечения. Однако новичок может не понять, что что-то является шуткой или сарказмом, даже если это очевидно для всех остальных. Это особенно важно при написании руководств. Подумайте, где уместны шутки, а где нет, и действительно ли они смешные.

Полезные страницы

Категории: Используемые, неиспользуемые и нужные

Шаблоны: Используемые, неиспользуемые и нужные

Файлы: Все, неиспользуемые и нужные

Все страницы: Все существующие страницы и Нужные страницы

Защищённые страницы

Очень немногие страницы защищены из-за их административной важности, деликатного содержания или чрезмерного вандализма. Редактировать эти страницы могут только администраторы. Список защищённых страниц можно найти здесь.

Страницы обсуждения

В вики у статей есть страницы обсуждения, а у пользователей — страницы обсуждения участников. Использование этих страниц не является распространённым явлением, но они обычно используются для общения между пользователями (очевидно) и предложения правок, защищённых страницах.
При написании на странице обсуждения или странице обсуждения участника (например, Talk:Main_Page), нужно знать несколько вещей.

Подпись

Всегда заканчивайте своё сообщение подписью, чтобы все знали, кто что написал (без необходимости проверять историю правок).
Это нужно делать, написав ~~~~ после своего сообщения. Вы можете настроить свою подпись на своей странице настроек.

Код:

Смотри. ~~~~

Результат:

Смотри. - Deantwo (обсуждение) 10:35, 30 ноября 2013 (CET)

Отступ

При ответе на сообщение другого пользователя обязательно сделайте отступ в своём сообщении, чтобы было видно, что это ответ на предыдущее сообщение.
Это делается путём добавления : в начале строки.

Код:

Смотри. - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|обсуждение]]) 10:35, 30 ноября 2013 (CET)
:На что? ~~~~

Результат:

Смотри. - Deantwo (обсуждение) 10:35, 30 ноября 2013 (CET)

На что? - Deantwo (обсуждение) 10:40, 30 ноября 2013 (CET)

Заголовок

Если вы начинаете новую тему, добавьте заголовок с названием темы. Если страница обсуждения используется часто, на ней может быть трудно ориентироваться, если темы не разделены заголовками. Это также позволяет редактировать отдельные разделы, что значительно упрощает редактирование длинных страниц обсуждения.
Это одна из самых основных и часто используемых функций в вики. Она используется путём ввода ==Тема== в строке над вашим сообщением. Просто замените «Тема» на то, о чём вы говорите.

Код:

==Посмотрите на это руководство==
Смотри. - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|обсуждение]]) 10:35, 30 ноября 2013 (CET)
:На что? - [[User:Deantwo|Deantwo]] ([[User_talk:Deantwo|обсуждение]]) 10:40, 30 ноября 2013 (CET)
::На это руководство, которое я написал. ~~~~

Результат:

Посмотрите на это руководство [править]


Смотри. - Deantwo (обсуждение) 10:35, 30 ноября 2013 (CET)

На что? - Deantwo (обсуждение) 10:40, 30 ноября 2013 (CET)
На это руководство, которое я написал. - Deantwo (обсуждение) 10:45, 30 ноября 2013 (CET)
Hosting Hosting a serverSetting up the databaseWorking with /tg/station as an upstream repository
Contributing Guide to contributing to the gameSetting up gitDownloading the source codeReporting issuesChangelogs
Coding Understanding SS13 codeSS13 for experienced programmersCode docsCoding standardsGetting Your Pull AcceptedBinary flags‎Text FormattingMySQL
Mapping Guide to mappingMap mergerGuide to door access
Spriting Guide to spritingResolving icon conflicts
Wiki Guide to contributing to the wikiWikicodeAutowiki