DecimalWiki:Памятка для авторов

Это развивающееся руководство о том, как внести свой вклад в Decimal Wiki и над чем работать.

Целью Decimal Wiki является создание и поддержка аккуратного, обновляемого, завершённого и лёгкого в использовании справочника для всех, кто интересуется блокчейном Decimal и сферой криптоэкономики в целом. Присоединяйтесь к нашему проекту! Чтобы создавать и редактировать статьи, вам необходимо зарегистрироваться.

С чего начать

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

Незарегистрированные пользователи не могут создавать и править статьи в Decimal Wiki.

После регистрации не стесняйтесь заполнить страницу своего профиля некоторой информацией о себе. Давайте познакомимся с вами!

О чём писать

Наполнение вики — это не только создание абсолютно новых страниц, но и улучшение качества существующих.

Decimal Wiki — не просто справочник по блокчейну Decimal. Мы рассчитываем создать полноценную вики-энциклопедию, посвящённую сфере криптовалют, блокчейнов и Web3, что предполагает создание обширного корпуса статей. Разобраться, какие темы затрагиваются в нашей вики, вам поможет список требуемых статей.

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

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

Просмотр и (при необходимости) редактирование или удаление спекулятивного контента помогает сохранить точность вики.

Как здесь редактировать

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

Нажмите ссылку «Править» в верхней части страницы. Откроется страница редактирования с текстом статьи и особыми символами — «вики-разметкой».
Внесите желаемые изменения в исходный текст.
Кратко опишите смысл своей правки в строке «Описание изменений».
Для проверки правильного отображения страницы нажмите кнопку «Предварительный просмотр».
Если со страницей всё в порядке, опубликуйте свою новую версию нажатием кнопки «Записать страницу».

Быстрые советы по редактированию

Тон статьи должен быть информативным и полу-профессиональным. Используйте третье лицо (напр., «криптоинвесторы», «участники рынка») в вводной части статьи. Допустимо использовать второе лицо в последующих параграфах и предложениях (особенно когда создаёте страницу инструкции), но старайтесь не писать от первого лица, если только вы не пишете о собственной компании.
Длина страницы или раздела может быть настолько велика, насколько требуется, но не больше; статья должна быть информативной и сжатой.
Используйте форматирование текста (напр., жирное начертание, курсив) умеренно. Старайтесь не использовать цветной текст, ~~зачеркивание~~, подчеркивание.
Соблюдайте правописание русского языка. Пишите полными предложениями, за исключением таблиц.
Добавляйте в текст соответствующие внутренние и внешние ссылки.
Добавьте изображения, если они будут полезны в контексте статьи; перед добавлением попробуйте поискать нужное вам изображение на странице Служебная:Список_файлов, а также в различных категориях изображений, чтобы избежать дубликатов. При обновлении существующего изображения загружайте новую версию того же самого файла, вместо загрузки нового изображения.
Добавляйте категории в статьи, если очевидная/полезная категория отсутствует. Проверьте страницу категорий, чтобы узнать, какую категорию можно добавить на страницу, и воздержитесь от создания категорий, которые не используются.
После внесения изменений, укажите в специальном поле снизу, что вы изменили. Это поможет остальным редакторам проверить вашу работу
Переименование страниц допустимо только в случае крайней необходимости. Если вы считаете, что это необходимо, оставьте соответствующий запрос к администраторам на странице обсуждения статьи.
Если вы считаете, что страница должна быть удалена, оставьте соответствующий запрос к администраторам на странице обсуждения статьи или поставьте на странице шаблон {{удалить|Причина удаления}}; укажите причину удаления.
Если вы хотите следить за изменениями в этой вики-странице или следить за новыми пользователями и правками, используйте страницу свежих правок.

Стиль статей

Тон

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

Длина статьи

Статья должна быть написана по существу и настолько велика, насколько это необходимо (особенно для более-менее широких тем). Старайтесь осветить все существенные аспекты, посвящая им отдельные разделы, но каждый аспект раскрывать по возможности лаконично. Не забывайте ставить вики-ссылки на «связанные» страницы в самом тексте или с помощью раздела «См. также».

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

Основная статья: DecimalWiki:Правила оформления страниц

Рис. 1: панель редактирования (общий вид)

Над окном редактирования вы видите панель инструментов (рис. 1). Нажав на ссылку «Дополнительно», вы увидите дополнительные кнопки для быстрой вставки вики-разметки: заголовков, списков, иллюстраций, таблиц и т. п. (рис. 2). По ссылке «Справка» вам откроется поле с краткими пояснениями по оформлению вики-текста (рис. 3). Не стесняйтесь пользоваться этими инструментами, чтобы придать вашему тексту красивый и завершённый вид.

Викификация

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

Текст

Форматирование текста может включать полужирный или курсивный текст, но не стоит злоупотреблять данными выделителями. Текст с большим содержанием отформатированных слов отвлекает читателя и снижает общую читабельность текста. Не используйте подчеркивание, цветной шрифт и т. д. Обычное форматирование текста не требует ~~зачеркивания~~, а подчеркнутый текст можно легко спутать с гиперссылками.

Отступы

Поля и отступы — это названия пространства вокруг элемента, будь то текст, изображение, таблица и т. д. На вики-странице не нужно специально ставить абзацные отступы. Другие элементы оформления абзацев можно делать с помощью CSS и атрибута style. Подробнее об использовании отступов вы можете прочитать здесь: margins и padding.

Правописание

В этой вики мы следуем стандартным правилам грамматики русского языка.

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

Заглавные (прописные) буквы

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

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

Заглавные буквы в заголовках и подзаголовках соответствуют русским, а не английским правилам: Пример подзаголовка статьи в Decimal Wiki, а не Пример Подзаголовка Статьи в Decimal Wiki.

В самом тексте, а также в обсуждении статей избегайте использовать CAPS LOCK. Запись КРУПНЫМИ буквами воспринимается как крик и считается неприличным тоном в интернет-среде.

Ссылки

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

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

Вы можете добавить внутренние вики-ссылки на другие статьи Decimal Wiki. Для этого используйте двойные квадратные скобки вокруг заголовка страницы, на которую вы хотите сделать ссылку. Например, [[Блокчейн]] выглядит как Блокчейн. Вы также можете использовать вертикальную полосу (|) для настройки заголовка ссылки — скажем, если не совпадает падеж. Например, при вводе [[Блокчейн|блокчейну]] получится блокчейну.

Вы можете добавлять внешние ссылки, заключив URL-адрес в одиночные квадратные скобки. Например, [http://www.tablesgenerator.com/mediawiki_tables TablesGenerator.com] становится TablesGenerator.com. Обратите внимание, что для отделения URL-адреса от необязательного текста используется пробел, а не прямой слэш (|), как в вики-ссылке.

Поскольку наша вики постоянно улучшается и развивается, страницы могут объединяться, удаляться или переименовываться. Например, страница Монета ранее называлась Криптомонета. Чтобы предотвратить возникновение «красных» ссылок на страницы, которые больше не существуют, администраторы оставляют перенаправляющие ссылки на удаленные или переименованные статьи. Это означает, что при создании новых внутренних ссылок в поле для предложений автозаполнения будут указаны эти старые названия ссылок. Когда пользователи вики переходят по старым ссылкам, они перенаправляются на новую страницу. Новая страница предупреждает пользователя о перенаправлении по старой ссылке сообщением под заголовком страницы «Перенаправлено с [старое название страницы]».

Заголовки разделов

Широкое использование подзаголовков (h2, h3, h4 и т. д.) разбивает статью на части, что облегчает чтение и позволяет автоматически генерировать оглавления. Однако слишком большое количество подзаголовков затрудняет чтение текста, особенно если связанный контент разбивается без необходимости. Чтобы текст было легко читать, старайтесь соблюдать баланс в количестве используемых заголовков.

Заголовки и подзаголовки не следует изменять без необходимости. На них могут быть ссылаться другие страницы и сайты за пределами нашей вики (например, GitHub и записи в блогах), поэтому любое изменение заголовка сделает эти ссылки нефункциональными. Если необходимо изменить заголовок, исправьте все ссылки, ведущие на него из других разделов Decimal Wiki.

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

Содержание (TOC)

Содержание страницы (TOC) генерируется автоматически после появления в статье четвертого подзаголовка типа h2. Можно заставить оглавление отображаться менее чем с четырьмя подзаголовками, включив в исходное представление редактора в начале вики-документа следующую переменную: __TOC__. Чтобы расположить оглавление с правого края страницы, введите в верхней части вики-документа шаблон {{TOC right}}.

Изображения

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

Последовательность действий описана на странице Загрузить файл. Названия загружаемых файлов чувствительны к регистру. При загрузке нового изображения под тем же названием старое изображение сохраняется в истории правок, так же, как текст статей. Если вы считаете нужным удалить старую версию изображения или изображение полностью, а также переименовать загруженный файл, обратитесь к администраторам.

Загрузка файлов отражается в журнале загрузки файлов. Просмотреть ранее загруженные файлы можно в списке или галерее загруженных изображений.

Типы файлов

Изображения желательно загружать в формате PNG с максимально доступным разрешением. В особых случаях допускаются различные форматы изображений (например, если необходим анимированный GIF).

Другие разрешённые типы файлов: jpg, jpeg, doc, xls, mpp, pdf, ppt, tiff, bmp, docx, xlsx, mp4, flac, mkv, mov, mp3, oga, ogg, ogv, wav, webm.

Авторское право

При написании статей или загрузке изображений соблюдайте авторское право.

Видео

В статью можно вставлять ролики с YouTube в виде окошка с потоковым видео. Это реализовано с помощью шаблонов {{youtube}} и {{yt}}. Инструкции по их использованию вы можете прочитать в документации на страницах этих шаблонов.

Категоризация статей

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

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

Описание изменений

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

Переименование страниц

В редких случаях страницу может потребоваться переименовать. Когда страница переименовывается, вики-движок автоматически создает на старой странице перенаправление («редирект»), которое будет содержать ссылку на новое название. Если вы хотите избежать этого, на странице переименования уберите галочку в строке «Оставить перенаправление».

При необходимости вы можете подать запрос администрации, чтобы страница с перенаправлением была удалена.

Удаление

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

{{удалить|Причина удаления}}

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

Создание черновика пользователя

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

Проще всего создать свой черновик, нажав на соответствующую ссылку на главной странице (рис. 4). Страница черновика создаётся в вашем личном пользовательском пространстве, ссылка выглядит так: [[Участник:Имя_участника/Черновик]].

Кроме того, вы можете создать черновик под любым другим названием (например, «Песочница»), совершив последовательность действий:

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

2. Добавьте /Песочница в конце URL в адресной строке браузера. Для этого нажмите на поле URL в вашем браузере, отмените выделение текста и введите «/Песочница» в самом конце. Нажмите Enter.

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

4. В открывшемся окне редактирования вставьте следующий код:

{{Черновик}}
<!--ПРАВЬТЕ НИЖЕ ЭТОЙ ЛИНИИ-->

5. Под этим вставленным текстом вы можете начать практиковаться в редактировании. Одна из идей для начала — добавить оглавление и ссылки на полезные шаблоны и ссылки, которые вам часто приходится просматривать.

6. Всякий раз, когда вы закончите редактирование в редакторе кода, нажмите «Внесённые изменения» под окном редактирования. Также вы можете посмотреть, как изменится страница, нажав на кнопку «Предварительный просмотр».

7. Нажмите «Записать изменения».

Совет: Чтобы легко найти свой черновик, добавьте ссылку на него на странице своего профиля. Для этого вставьте следующий код в окне редактирования вашей страницы пользователя, заменив «Имя_участника» на ваше собственное имя пользователя: [[Участник:Имя_участника/Название_страницы|Мой черновик]]

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

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

Обновление страниц

Иногда страницы могут вести себя странно, как будто сделанные вами изменения не внесены. Если это происходит, попробуйте добавить ?action=purge в конец URL-адреса и перейти по этому адресу. Это приведёт к перезагрузке страницы и устранению многих проблем.