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

Версия от 18:45, 22 марта 2025; Ziron (обсуждение | вклад) (Добавил шаблоны о замене цветов и устаревшем.)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)

Приветствуем Вас и добро пожаловать на Вики проекта SS220 Paradise Station!

Вероятно, Вы являетесь будущим Участником вики, раз интересуетесь, какой именно вклад Вы можете внести в развитие Вики нашего сервера.

Перед тем, как вносить значительные правки, мы настоятельно рекомендуем Участникам прочитать Настоящие Правила Вики. В данном Руководстве по редактированию вики описывается структура данного вики, принципы внесения правок и определенные моменты, на которых должны сосредоточить свои усилия Участники. Вы научитесь делать эффективные и полезные правки, а также получите знания, которые помогут начать писать качественные статьи.

Правила вики

Несоблюдение нижеуказанных пунктов может привести к блокировке на всех вики проекта SS220, поэтому если вы хотите вносить вклад, то пожалуйста, потратьте несколько минут на их прочтение. Данные правила возникли, как необходимая мера, против «рофлоперевода», машинного перевода, а также жалоб на переводы, поэтому добросовестных редакторов они будут касаться минимально.

Политика по переводу

  1. Перевод (в отличие от редактирования) должен соответствовать по содержанию оригинальной странице сборки Paradise,TG за исключением случаев, когда информация с оригинальной страницы не соответствует реалиям текущей сборки, например при разнице обновлений.
  2. Адаптированный перевод, т.е. добавление собственного текста, допускается на страницах-руководствах. Для иных страниц требуется оповещение (в дискорде).
  3. При переводе должны использоваться общепринятые расшифровки и аббревиатуры, отличающиеся от билда к билду. Если при переводе вам встретилась аббревиатура, которая отсутствует на данной странице (Словарь_Аббревиатур, то сообщите об этом в дискорде.
  4. Рофлоперевод, а также машинный перевод, т.е. прогонка текста через онлайн переводчик без последующего исправления, запрещены и презираются даже на незаконченных страницах.
  5. Именные вставки, т.е. выделение определённого человека в тексте по различным причинам, запрещено на любых страницах и руководствах вики, за исключением Песни, Образцы документов и подобных страниц на других вики.
  6. Излишнее использование зачёркиваний, жирного текста, увеличенного текста, курсива и т.д. не приветствуется, если соответствующего нет на оригинальной странице.

Политика по редактированию

  1. Описание изменений должны содержать в себе компактную, но подробную информацию о редактировании.
  2. В случае внесения малого вклада на страницу, также требуется заполнение описания изменений.
  3. Переименовывание страниц вики запрещено, кроме случаев, когда название не переведено или кардинально отличается от содержания страницы. В основном потому что это наверняка сломает ссылки и перенаправления (в том числе двойные перенаправления) на страницу.

Что такое вики и зачем мы над ней работаем?

Проект SS220 один из самых больших по меркам SS13 из-за чего он привлекает много новых игроков. Помимо новых игроков также существуют разительные отличия в билдах (a.k.a. версиях) серверов SS13. Вики создаются и дополняются игроками для таких же игроков, чтобы минимизировать влияние опыта на РП процесс или саму игру. Каждая вики содержит в себе множество руководств и документаций, которые объясняют различные аспекты и механики в читаемом и понятном виде. Мало того, что вики делает эту информацию доступной, так в ней еще и проходит процесс организации, помогающий игрокам в поиске того, что им требуется. Если информация доступна в игре, то на вики он должен узнать больше.

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

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

Внесение изменений

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

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

Основные направления

Это краткий список вводной информации для начала редактирования.

Если вы в чём-то сомневаетесь — не стесняйтесь спрашивать об этом в дискорде.

Общий вики-этикет и принятые нормы

  • Не стоит писать в заголовках Каждое Слово С Заглавной Буквы, т.к. по нормам русского языка — это допустимо лишь в начале предложения и для имен собственных.
    • Следовательно это распространяется и на заголовки, и на названия страниц.
    • Исключением также не являются ссылки, которые часто внедряются внутрь предложения.
  • Не стоит злоупотреблять ссылками.
    • Для навигации хватает лишь ссылок при первом упоминании чего-либо на странице, в остальной же её части достаточно лишь текста.
    • Для навигации внутри википедии существуют внутренние ссылки, которые оформляются в двойные квадратные скобки, поэтому не стоит использовать внешние ссылки для внутренней навигации.
  • Если вы изменили название страницы, то обязательно нажмите на «Ссылки сюда» в боковой панели вики и убедитесь, что вы не создали двойные перенаправления.
    • Исправление двойного направления проще чем кажется. Вы находите страницу, которая некорректно отсылает к прошлому названию и через кнопку «править» изменяете перенаправление на нужное.
  • Описание изменений должно содержать информацию о редактировании. Это упрощает работу по улучшению вики.
    • Малые изменения включают в себя от самого малого, по типу изменения букв, пунктуации, грамматики, до более крупного, такого как изменение содержания раздела. Если вы редактируете страницу в целом, или раздел довольно обширный, то не стоит нажимать кнопку «Малое изменение».
  • На вики допускается лишь русский язык, желательно с соблюдением всех норм.
    • Английский текст используется, как дополнительный, в качестве указания на объект в целях упрощения его поиска.
    • Существуют некоторые слова, которые не принято переводить, например NanoTrasen.
    • Другие слова требуют такого же перевода, как на остальной вики, т.е. не надо называть тенеморфов «тенелингами».
  • Названия новых изображений, которые вы загружаете на вики, должны быть на латинице и соответствовать содержанию, т.е. не надо называть банан — блюспейс кристаллом.
    • Код страницы желательно держать в общей стилистике, т.е. на латинице. Это подразумевает использование px вместо пкс, File: вместо Файл: и т.д.
  • Воздержитесь от излишнего юмора/выделения
    • Википедия проекта SS220 старается находиться в более-менее серьезном виде. Остроумная одиночная шутка может оказаться хорошим дополнением к странице, но постоянный зачеркнутый юмор — нет.
    • Выделения и изменение размера текста должно оставаться для заголовков, заметок или важной информации. Не используйте выделения без необходимости.

Некоторые стандарты

Мы стараемся соблюдать некоторые стандарты на вики, ниже перечислен их список.

Цвета

Все цвета элементов(таблицы, шаблоны и т.п.) должны задаваться с помощью шаблона ColorPalette.
Если по какой-то причине там нет нужного вам цвета, нажмите F12 и посмотрите все доступные CSS переменные.
Вам скорее всего нужны переменные начинающиеся на --color

Если вам нужно покрасить текст в определённый цвет, воспользуйтесь шаблоном Color

Создание новой страницы

По мере добавления нового контента в игру может появиться что-то достаточно уникальное, оправдывающее наличие собственной вики-страницы. Перед созданием настоящей страницы — вы можете отредактировать собственную страницу пользователя, которая является некой «песочницей» для вас.

Редактирование статьи

Так как страницы вики требуют регулярные исправления, чтобы оставаться актуальными и иметь всю возможную полезную информацию, важно понимать не только как их создавать, но и как редактировать. Чтобы начать редактирование страницы, редактор должен находиться на нужной странице и нажать «Править» или «Править код» (между кнопками «Читать» и «История» сверху).

Загрузка файлов

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

Базовый синтаксис для вики

Форматирование текста

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

Ссылки

Очень важно, чтобы все страницы были взаимосвязаны, поэтому на каждой странице есть ссылки и якоря (Anchor). Для того, чтобы получилась настоящая вики мы должны внедрять ссылки внутрь текста, если присутствуют термины, а также добавлять ключевые слова, чтобы было проще найти страницы через поисковую строку.

Изображения

Использование изображений крайне важно на нашем вики. Без них достаточно сложно передать внешний вид иконок, мобов, а также визуально представить читателю, что от него требуется.

Таблицы

Старайтесь помещать большой объем данных в таблицы, чтобы читателям было проще воспринимать информацию.

Организация вики

Как было сказано ранее, делать информацию доступной и простой для поиска так же важно (если не более), чем предоставление объема этой самой информации для чтения. Наша вики организована следующим, довольно специфичным способом.

Тип страницы

Все страницы вики делятся на 6 различных типов:

  • Локации: На странице размещается изображение какой-то одной локации на станции и соответствующая информация: краткое описание, содержимое локации, уровень безопасности, доступа и прочее.
  • Роли/Должности: Страница описывает роль/должность и её цели, а также краткий список своих обязанностей на должности во время смены. Эти страницы могут служить мини-руководством по роли (но, чаще всего, под это рассчитана отдельная статья). Также на них размещается информация по механикам, уникальным для конкретной роли.
  • Руководства: Страница, созданная для обучения игроков механикам и особенностям игры. Это может быть объяснение, как получить конкретный предмет, совершить определенное действие и в целом применять все признаки и особенности предмета.
  • Предметы: Страница отображает все доступные внутриигровые предметы/объекты/структуры по выбранной категории. В основном это перечисление списка объектов, включающего название, спрайт и краткое описание объекта с указанием его возможных применений и ссылками на соответствующие руководства/роли.
  • Лор: Страница с описанием составляющих лора нашего сервера.
  • Навигация: Страница, целью которой является указать читателю на статьи с искомой информацией. На этой странице могут быть приведены поверхностные знания о широких понятиях. Примеры: статья об отделе в целом, или надлежащими механиками (роли).

Навигация по странице

Наличие вики с трехзначной нумерацией страниц ставит в неловкое положение: даже если вся необходимая и релевантная информация доступна, как эффективно предоставить доступ к ней читателю? Поисковый движок Mediawiki — из достаточных способов. Простейшим является объединить обе страницы, чтобы можно было легко переходить от статьи к статье, а также создавать страницы навигации, которые будут служить справочником для всех релевантных статей раздела (К примеру, "Инженерия" или "Антагонисты").

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

Ссылки внутри статьи

Для читателя не имеет смысла переходить на страницу навигации, если им нужно найти страницу, близко относящуюся к статье, которую в данный момент они читают. Существуют несколько практик, которые позволяют быстро переходить между похожими статьями.

  • Внутренние ссылки: Ваш хлеб с маслом, выглядит следующим образом: [[Космический Закон|Космозакон]] Космозакон на странице. Они позволяют читателю переместиться на относящуюся к теме статью. Очень важный механизм, который применяется для терминов или фич, описание которых не нужно приводить в тексте, к примеру, если в статье говорится о Капитане или упоминается одно из случайных событий.
  • Боковые панели: Наиболее быстрый способ навигации по категории. Они не обязательно связывают статьи одного типа но связывают статьи, относящиеся к рассматриваемой теме. Например: Боковая панель инженерии видна на всех этих страницах — Инженер, Руководство по строительству, и Атмосферика — поскольку все относятся к статьям по теме "Инженерия" (и крайне полезны для получения базовой информации об Инженерном деле на станции).
  • Нижние инфоблоки: Служат для объединения всех статей одного типа. К примеру, в конце статьи о роли располагается большой инфоблок с ссылками на все статьи о ролях. В отличие от боковых панелей, не относятся к определенной теме.

Эти три способа создания ссылок в статьях прекрасно работают в тандеме. Если правильно их применять, читатель сможет перемещаться от статьи к статье в один миг.


Страницы навигации (В разработке)

А что по поводу ссылок, которые не соотносятся? Будет неэффективно (скорее, бесполезно) для читателя, если каждая статья ссылается на абсолютно все статьи. Такой большой объем ссылок приводит к той же проблеме недоступности требуемой информации (как если бы ссылок не было вовсе). Решением стало создание так называемых справочников — Страниц навигации. Они служат для объединения всех статей по определенной теме на одной странице. Они похожи чем-то на боковые панели, но в отличие от последних позволяют перемещаться между другими страницами навигации. Это значит, что вместо того, чтобы переходить от одной связанной статьи к другой, читатель может перемещаться от одной категории к другой. К примеру, Engineering Portal позволяет не только получить информацию об инженерии, но и перейти на навигационные страницы, относящиеся к совершенно другим категориям: Antagonist Portal или Security Portal.

Шаблоны вики

Шаблоны вики — это то, как участники размечают код, который реплицируется на нескольких страницах. Например, большинство заголовков, боковых панелей, заголовков обслуживания и других стандартизированных элементов пользовательского интерфейса страницы хранятся в шаблонах. Шаблон — это именно то, что определяет это слово, предопределенный код, который можно легко вставить на любую вики-страницу с помощью простого вызова шаблона. Для обычного участника вики важно только понимать, как использовать эти шаблоны, а также какие шаблоны доступны для использования и когда их можно использовать!

Как использовать

Дисклеймер: Крайне важно прочитать документацию по шаблонам, чтобы знать, какие параметры они принимают!

Для вызова шаблона используется двойная пара фигурных скобок: {{ и }} Между этими скобками размещается имя шаблона.

К примеру, чтобы отметить, что статья находится в разработке, используется шаблон В разработке (см. Template:Wip). Кроме того, этот шаблон принимает переменную assign, и при вызове шаблона можно задать этот параметр, используя символ '|' для разделения. 

{{Wip|assign=BOT Purple}}
Эта страница активно дополняется
Дабы не мешать друг другу, пожалуйста, согласуйте ваши правки с подрядчиком:
BOT Purple


Хотя можно и скопировать код шаблона, данный способ быстрее, проще и короче рассмотрим другие варианты с применением многих параметров.

Здесь мы вызываем шаблон роли. Мы можем определить параметры, открыв вызов шаблона и используя некоторые идентификаторы строк: 

{{JobGuides
 | colour     = #CCAE18
 | department = Burger
 | image      = Burger.png
 | roleheader = Burger Jobs
 | roleguides = Burger Guides
}}

Таким образом мы заполняем пропущенные параметры, и на выходе получится:

Burger

Глава отдела
placeholder

Канал связи placeholder

Сотрудники Департамента
placeholder - placeholder - placeholder
Руководства для Сотрудников
placeholder - placeholder - placeholder
Зоны для {{{department2}}}
placeholder

Как показывает опыт, всегда полезно просмотреть другую страницу с таким же шаблоном, чтобы увидеть, как он используется. Это не только экономит время, но и, как правило, сообщает вам, как используются другие параметры.

Типы шаблонов

Шаблоны обслуживания

Все эти шаблоны представляют собой заголовки, которые указывают на то, что на странице есть что-то, что требует действий от участников вики для исправления, создания или обновления.

Требует пересмотра
  • Наиболее распространенный шаблон указывает участникам, что что-то на странице следует пересмотреть.
  • Наиболее полезно для указания неверной информации, неправильного форматирования, отсутствия информации или других ошибок в статье.
{{Needsrevision|reason=На этой странице не хватает информации о бургерах}}
Эта страница должна быть пересмотрена/обновлена
Эта статья содержит устаревшие данные, необходимо сверить и обновить информацию.
Причина: На этой странице не хватает информации о бургерах


В разработке
  • Указывает авторам и читателям, что статья не завершена и находится в процессе завершения.
  • Наиболее полезно для новых страниц или переписывания из-за больших переделок/рефакторингов.
{{Wip|assign=Клувня}}
Эта страница активно дополняется
Дабы не мешать друг другу, пожалуйста, согласуйте ваши правки с подрядчиком:
Клувня


Заготовка
  • Указывает участникам, что читателям/участникам нужна эта страница, но ее необходимо заполнить.
  • Полезно для выделения страниц для информации, которой нет на вики, но должна быть
{{Stub}}
Данный раздел или данная статья являются Заготовкой
Вы можете помочь, дополнив её.


Нужно переписать
  • Указывает участникам, что эта страница должна быть полностью переписана либо с нуля, либо каждый раздел должен быть пересмотрен/проверен.
  • Наиболее полезно для старых страниц, имеющих проблемы с основным форматированием и стилем написания, которые не стоят усилий по доработке с небольшими изменениями за раз.
{{Rewrite|reason=На этой странице большинство разделов поощряют действия, которые противоречат правилам сервера или нашим правилам в отношении содержимого вики.}}
Код данной страницы должен быть переписан
Причина: На этой странице большинство разделов поощряют действия, которые противоречат правилам сервера или нашим правилам в отношении содержимого вики.


Отсутствуют изображения
  • Указывает участникам, что на этой странице отсутствуют изображения, которые являются ссылками, и другой участник должен загрузить их.
  • Полезно для участников, которые не очень хорошо разбираются в получении изображений из кода, но способны создавать статьи, которым нужны изображения в дополнение к ним.
{{Missing Images|Missing=Нет спрайтов лута с лаваленда, относящегося к магии и оккультизму.}}
На данной странице недостаточно изображений, или же они вовсе отсутствуют
Нет спрайтов лута с лаваленда, относящегося к магии и оккультизму.


К удалению
  • Используется как для файлов, так и для статей, указывает, что страницу следует удалить.
  • Этот шаблон следует использовать экономно и только для статей с заголовками, которые не являются полезными перенаправлениями и/или не должны быть на вики.
  • Этот шаблон следует использовать для файловых страниц, которые никогда не будут использоваться на вики в ближайшем будущем, или для дублирующих файлов.
{{Подлежащие удалению
|причина = "Дубликат" или "Нахрена эта страница существует? Кто придумал, что «Крабовый культ» — хоть сколько-нибудь полезное название для статьи?"}}
Эта страница подлежит удалению
Данный раздел или данная статья подлежит удалению. Решение может быть пересмотрено и, возможно, отменено при удалении данного шаблона.
Причина: "Дубликат" или "Нахрена эта страница существует? Кто придумал, что «Крабовый культ» — хоть сколько-нибудь полезное название для статьи?"


Устаревшие файлы

Используется для файлов, содержащих изображения устаревших элементов, таких как спрайты, локации или объекты, в которые были внесены изменения и которые теперь выглядят по-другому. 

{{Outdated File|reason=Tета перешла от сингулярности к оборудованию тесла.}}
Данная страница имеет устаревшую информацию, которую необходимо обновить
Причина: Tета перешла от сингулярности к оборудованию тесла.


Низкое качество

Используется практически по любой причине, кроме «устаревшей» для файлов. Возможно, изображение имеет низкое разрешение, имеет случайные метки, было снято неправильно или содержит неверную информацию/контент. 

{{Low Quality|reason=Предпочтительно внутриигровые скриншоты (Не SDMM)}}
Имеется файл плохого качества, который требуется заменить
Причина: Предпочтительно внутриигровые скриншоты (Не SDMM)


Ограниченый контент

Используется для страниц о чём-то, что уже частично введено в игру, но ещё недоступно на всех игровых серверах SS220. Не забудьте указать — почему контент ограничен и где он доступен. Типичные примеры — новые расы и новые антагонисты. 

{{Ограничено|Контент в разработке. Проходит тестирование на прайме}}
Контент этой страницы сейчас ограничен или недоступен в игре
Контент в разработке. Проходит тестирование на прайме


Требуется перевод

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

{{Требуется перевод}}
Этой странице требуется перевод
Эта статья содержит непереведенную информацию.


Требующие Новые Цвета

Страницы, цветовая гамма на котрых не соответствует стандарту [ColorPalette]. 

{{BadColors}}
Нет поддержки тёмной темы
На данной странице, могут быть проблемы при использовании тёмной темы.
Необходима конвертация цветов в шаблон ColorPalette


Устаревший

Страница устарела либо информационно, либо морально. 

{{Устаревший}}
Эта статья содержит сведения об устаревшем контенте
В этой статье содержатся сведения о контенте, удалённом из Space Station 13 (или, по крайней мере, на этом сервере). Данная страница сохранена в исторических целях и заархивирована.


Шаблоны страниц

Это стандартные шаблоны, которые мы используем для наших статей! Их слишком много, чтобы перечислять, поэтому они просто перечислены ниже.

  • Заголовки
    • {{JobPageHeader}}
    • {{Location}}
    • {{Obsolete}} — Указывает на страницу, содержащую контент, полностью удаленный из игры.
    • {{Out of Rotation}} — Указывает на страницу, которая содержит игровые режимы, руины, события, которые не появляются естественным образом (не включает только предметы/роли, созданные администратором).
    • {{{{NonIC}}}} — Указывает на страницу, содержащую контент, который игроки не должны знать In-Character (зарезервировано только для DeathSquad и SST)
    • {{JobsTable}} — Список всех ролей
    • {{Locations}} — Список всех локаций
    • {{Archive}} — Список всех устаревших страниц
Источник — https://wiki.ss220.club/index.php?title=Руководство_по_редактированию_вики&oldid=44938