Help:Editing (Русский)
ArchWiki использует MediaWiki — пакет свободного программного обеспечения, написанный на PHP и изначально разработанный для Википедии. Подробную информацию о MediaWiki вы найдёте на страницах Справка:Содержание в MediaWiki и Википедия:Справка.
Перед вами краткое руководство по редактированию ArchWiki. Прежде чем редактировать или создавать страницы, ознакомьтесь с общими характером, разметкой и стилем существующих статей. Необходимо стремиться поддерживать качество и единый стиль вики-статей. Общие правила перечислены в статьях ArchWiki:Внесение вклада, Help:Стиль и Help:Чтение. Для экспериментов можно использовать песочницу. Краткую информацию о вики-разметке вы найдёте на странице Help:Шпаргалка.
Создание аккаунта
Для внесения правок на страницы ArchWiki необходимо создать аккаунт; чтобы ответить на вопрос-капчу, потребуется обновлённое до последней версии окружение Arch Linux. Пользователи других дистрибутивов также могут править ArchWiki, для ответа на капчу они могут, например, загрузить live-окружение Arch c помощью последней версии установочного образа, использовать pacman-staticAUR (доступны предварительно скомпилированные двоичные файлы) или просто запустить контейнер-образ с помощью, например Docker_(Русский).
После создания аккаунта выполните вход на странице Special:UserLogin.
Редактирование
Чтобы начать вносить изменения на странице, выберите вкладку Edit source наверху. Вы можете также редактировать конкретный раздел на странице, нажав на ссылку edit source справа от его заголовка. После этого появится страница Editing Название страницы или Editing Название страницы (section), которая состоит из следующих элементов:
- панель инструментов для редактирования (необязательно);
- поле редактирования;
- поле Описание изменений;
- ссылки Save changes, Show preview, Show changes и Cancel.
Поле редактирования будет содержать wikitext текущей версии статьи или раздела — редактируемый исходный код, из которого сервер создает web-страницу. Чтобы выполнить редактирование:
- Измените викитекст как вам нужно (подробнее в разделе #Форматирование).
- Кратко объясните ваши изменения в поле Описание изменений (например, "исправлена опечатка" или "добавлена информация о xyz").Примечание Все правки должны сопровождаться описанием изменений. Описание позволяет администраторам и другим мейнтейнерам легко определять спорные правки и вандализм. Подробнее см. ArchWiki:Внесение вклада#Три основных правила.
- Старайтесь всегда использовать кнопку Show preview, чтобы проверить форматирование перед сохранением.
- Если правка не вносит смысловые изменения в содержимое (например, вы исправили только форматирование), отметьте ее как незначительную, установив флажок Малое изменение.
- Сохраните изменения, нажав на кнопку Save changes. Если вы передумали вносить изменения, нажмите Cancel.
Отмена правок
Изменения должны улучшать содержимое страницы. Если какая-то правка наоборот, ухудшает содержимое или просто сделана по ошибке, следующие шаги помогут вам правильно ее отменить:
- Выберите вкладку View history наверху страницы (рядом с вкладкой Edit source). Вы увидите список изменений на странице.
- Найдите неверную правку и кликните по ссылке undo напротив нее. Вы увидите предварительный просмотр, показывающий текущую версию (слева) и текст для сохранения (справа).
- В поле описания изменений укажите причину, почему вы отменяете правку.
- Если все правильно, нажмите на кнопку Save changes внизу страницы.
После этого страница будет возвращена в изначальное состояние.
Иногда необходимо отменить сразу несколько последних правок за раз. Для этого:
- Выберите вкладку View history наверху страницы (рядом с вкладкой Edit source). Вы увидите список изменений на странице.
- Найдите версию, до которой вы хотите отменить все изменения (то есть, последнюю хорошую версию). Нажмите на соответствующую ей временную метку. Вы увидите выбранную версию страницы.
- Если все правильно, нажмите на вкладку Edit source вверху страницы. Вы увидите предупреждение: "Вы редактируете устаревшую версию данной страницы."
- В поле описания изменений скопируйте временную метку версии (отображается наверху) и укажите причину, почему вы отменяете последние правки.
- Теперь просто нажмите на кнопку Save changes, чтобы откатить все изменения до выбранной версии.
Создание страниц
Прежде чем создавать новую страницу, пожалуйста, ответьте на следующие вопросы:
- Относится ли ваша тема к Arch Linux? Ненужные и бесполезные статьи будут удаляться.
- Будет ли ваша тема интересна другим? Учитывайте не только то, о чем вы желаете написать, но и то, что другие хотели бы прочитать. Личные заметки должны находиться на вашей странице пользователя (либо на ее подстранице).
- Достойна ли ваша тема новой страницы? Поищите похожие статьи. Если такая статья есть, подумайте о ее улучшении.
- Будет ли ваш вклад существенным? Избегайте создания страниц-заглушек, если не планируете расширять их вскоре после этого.
Создавая новую страницу, выберите подходящий заголовок и соответствующую категорию.
Страницы Help:Указания по выбору имен статей и Help:Стиль#Заголовок помогут вам выбрать хороший заголовок. Не включайте "Arch Linux" или его разновидности в заголовки страниц. Это — ArchWiki, соответственно предполагается, что статьи здесь так или иначе относятся к Arch Linux (например, Установка Openbox, а не Установка Openbox в Arch Linux).
Посетите Оглавление, которое поможет вам выбрать подходящую категорию. Статья может принадлежать сразу нескольким категориям.
Чтобы добавить новую страницу к какой-либо категории (скажем, "Моя новая страница" в "Некоторая категория"), вам необходимо:
- Создать страницу с вашим новым заголовком, перейдя по ссылке: https://wiki.archlinux.org/title/My_new_page (само собой, вам необходимо заменить "My_new_page" на реальный заголовок).
- Добавить
[[Category:Какая-либо категория]]на самом верху страницы.
На этом этапе новая страница всё ещё считается страницей-сиротой. Чтобы завершить процесс создания, добавьте в другие статьи ссылки на неё. Это повысит её "видимость" и, возможно, побудит других пользователей внести свои улучшения. В первую очередь подумайте о страницах связанных с вашей статьё программ, обзорных статьях и различного рода списках вроде Список приложений.
В некоторых случаях имеет смысл вместо написания отдельной статьи создать подстраницу, т.е. "потомка" другой страницы: заголовок подстраницы отделяется от основной страницы символом слэша /. Это можно использовать для работы с черновиками статей в пространстве страницы вашего профиля, например https://wiki.archlinux.org/title/User:Myself/My_new_subpage.
Форматирование
Везде, где это возможно, форматирование текста производится при помощи вики-разметки, так что вам не придется изучать HTML. Различные шаблоны также доступны для распространенных задач форматирования: подробнее смотрите на странице Help:Шаблон. Help:Шпаргалка резюмирует наиболее распространенные опции форматирования.
Заголовки и подзаголовки
Заголовки и подзаголовки являются простым способом организовать содержимое статьи. Если вы можете выделить в тексте несколько отдельных тем, разделите их, создав для каждой из них свой раздел. Страницы Help:Стиль#Заголовки разделов и Help:Эффективное использование заголовков помогут вам сделать это правильно и придумать разделам подходящие названия.
Заголовки должны начинаться со второго уровня и создаются следующим образом:
== Заголовок второго уровня == === Заголовок третьего уровня === ==== Заголовок четвертого уровня ==== ===== Заголовок пятого уровня ===== ====== Заголовок шестого уровня ======
Если в статье имеется хотя бы четыре заголовка, автоматически будет сгенерирован блок оглавления. Если вы этого не желаете, поместите специальное слово __NOTOC__ в начале статьи. Попробуйте создать несколько заголовков на странице Песочница и посмотрите на результат в содержании.
Переносы строк
Пустая строка в коде страницы используется для разделения текста на абзацы. Обратите внимание, что текст на двух соседних строках воспринимается как один абзац.
Для ручной вставки переносов вы можете использовать HTML-тег <br>, однако этого следует избегать везде, где возможно. Его использование необходимо только при совмещении с некоторыми другими элементами разметки, например, списками.
| викитекст | результат |
|---|---|
Это предложение разделено на три строки. |
Это предложение разделено на три строки. |
Абзац номер один. Абзац номер два. |
Абзац номер один. Абзац номер два. |
* Так можно оформить пункт списка <br> на нескольких строках * Однако, обычный перенос строки заканчивает список |
заканчивает список |
Смотрите статью Help:Стиль/Пробелы для получения дополнительной информации об использовании пробельных символов в исходном коде страниц.
Полужирный и курсив
Полужирный шрифт, курсив и полужирный курсив добавляются путем заключения слова или фразы в два, три или пять апострофов ('):
| викитекст | результат |
|---|---|
|
|
курсив |
|
|
полужирный |
|
|
полужирный и курсив |
Зачеркнутый текст
Используйте зачеркнутый текст, чтобы стилистически отобразить, что какое-то утверждение перестало быть истинным или стало бесполезным.
| викитекст | результат |
|---|---|
<s>Зачеркнутый текст</s> |
|
Списки
Помните, что синтаксис wiki не поддерживает многострочные элементы списков: каждый символ новой строки завершает элемент списка. Чтобы начать с новой строки внутри элемента, используйте тег <br>. Чтобы вставить многострочный блок кода внутрь элемента списка, используйте Template:bc и экранируйте содержимое с помощью тегов <nowiki>...</nowiki>. Смотрите также статьи Help:Стиль/Пробелы и Help:Шаблон.
Маркированные списки
Маркированные списки не указывают наличие строгого порядка следования пунктов.
Чтобы вставить маркер, используйте звездочку (*). Вы можете создавать вложенные списки, используя несколько звездочек *.
| викитекст | результат |
|---|---|
* Первый пункт * Второй пункт ** Подпункт * Третий пункт |
|
Нумерованные списки
Пунктам нумерованных списков присваиваются номера, таким образом обозначая, что порядок их следования важен. В целом следует использовать неупорядоченные списки, если порядок элементов не имеет значения.
Чтобы создавать нумерованные списки, используйте знак номера или символ решетки (#). Вы можете создавать вложенные списки, используя несколько таких символов #.
| викитекст | результат |
|---|---|
# Первый пункт # Второй пункт ## Подпункт # Третий пункт |
|
# Первый пункт # Второй пункт #* Подпункт # Третий пункт |
|
Списки определений
Списки определений (также известные как списки описаний) создаются с помощью точки с запятой (;) и двоеточия (:), следующего за термином.
| викитекст | результат |
|---|---|
Списки определений: ; Клавиатура: устройство ввода с кнопками или клавишами. ; Мышь: указательное устройство для двумерного ввода. или ; Клавиатура : устройство ввода с кнопками или клавишами. ; Мышь : указательное устройство для двумерного ввода. |
Списки определений:
или
|
Используйте дополнительные двоеточия, если термин имеет несколько значений: ; Термин : первое значение; : второе значение. |
Используйте дополнительные двоеточия, если термин имеет несколько значений:
|
Блок кода в элементах списка
Пример с блоком кода в списке:
| викитекст | результат |
|---|---|
# Первый пункт
# Второй пункт: {{bc|<nowiki>
code1
code2
code3
</nowiki>}}
# Третий пункт
|
|
Отступы
Чтобы сделать отступ в тексте, поместите двоеточие (:) в начале строки; пробел после : необязателен. Чем больше двоеточий вы поставите, тем больше будет отступ. Новая строка отмечает окончание абзаца с отступом.
| викитекст | результат |
|---|---|
Этот текст без отступа. : Этот текст с небольшим отступом. :: Этот текст с более сильным отступом. |
Этот текст без отступа.
|
- Используйте отступы только тогда, когда это строго необходимо для получения желаемого оформления.
- На страницах обсуждения используйте их для создания отступов в ответах (см. Help:Обсуждение).
Код
Чтобы добавить блок кода в wiki, используйте один из шаблонов форматирования кода. Также вы можете просто начинать каждую строку с единичного пробела, например:
$ echo Hello World
Смотрите также Help:Стиль#Форматирование кода.
Таблицы
При правильном использовании таблицы могут помочь организовать большое количество данных в наглядном виде. Для продвинутого синтаксиса и форматирования таблиц смотрите Wikipedia:Help:Table.
| викитекст | результат | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{| class="wikitable"
|+ Табличные данные
! Дистрибутив !! Цвет
|-
| Arch || Синий
|-
| Gentoo || Фиолетовый
|-
| Ubuntu || Оранжевый
|}
|
|
||||||||||||||||||
{| class="wikitable"
! Файловая система !! Размер !! Использовано !! Доступно !! % использования !! Точка монтирования
|-
| rootfs || 922G || 463G || 413G || 53% || /
|-
| /dev || 1.9G || 0 || 1.9G || 0% || /dev
|}
|
|
Ссылки
Ссылки необходимы, чтобы помочь читателям перемещаться по сайту. В целом редакторы должны следить, чтобы каждая статья содержала исходящие ссылки на другие статьи (избегайте тупиковых страниц) и на неё ссылались другие статьи (специальная страница Ссылки сюда показывает входящие ссылки). См. также Help:Стиль/Форматирование и пунктуация#Первые вхождения.
Внутренние ссылки
Вы можете делать очень много перекрестных ссылок в вики, используя внутренние ссылки. Чтобы создать ссылку на другую страницу в той же wiki, просто возьмите ее название в двойные квадратные скобки.
Например, ссылка на статью pacman (Русский) в тексте будет выглядеть так:
[[pacman (Русский)]]
Если вы хотите использовать слова, отличные от заголовка статьи, в качестве текста ссылки, вы можете добавить альтернативное имя после символа |.
Например:
[[ArchWiki:About (Русский)|ArchWiki]] является основным источником документации по Arch Linux в сети.
Результат:
- ArchWiki является основным источником документации по Arch Linux в сети.
Shift+\ в английской раскладке и аналогичных.Вы можете также воспользоватсья возможностью добавления окончаний к последнему слову в ссылке (вроде "s", "es" для мн. ч., или, например, "ing" для герундия), при котором окончание включается в отображаемый текст ссылки, но не затрагивает ее саму.
Вот как это работает:
makepkg is used in conjunction with [[PKGBUILD]]s.
Результат:
- makepkg is used in conjunction with PKGBUILDs.
Ссылки на разделы
Чтобы создать ссылку на раздел, просто добавьте # сразу за заголовком статьи и укажите заголовок раздела.
Например:
[[Help:Редактирование#Ссылки на разделы]]
Результат:
[[#Ссылки на разделы]]). Pipe trick
В некоторых случая удобно воспользоваться так называемым приемом "pipe trick" ("трюк с пайпом"), который позволяет упростить работу, автоматически подставляя подходящий текст ссылки. В ArchWiki он может быть полезен в двух случаях:
- Чтобы автоматически убирать языковой суффикс из текста ссылок. Например, викитекст
[[Main page (Русский)|]]будет заменен на Main page. - Когда требуется явное указание пространства имен в ссылке, эта возможность позволяет автоматически убрать префикс пространства имен из текста ссылки. Например, викитекст
[[ArchWiki:About|]]будет заменен на About, а[[Wikipedia:Help:Pipe trick|]]— на Help:Pipe trick.
Когда вы сохраняете страницу, все ссылки с пайпом в конце заменяются на ссылки с текстом, который вычисляется по специальным правилам на основе самой ссылки. При этом изменяется сам исходный код страницы. Смотрите подробнее на странице Wikipedia:Help:Pipe trick.
Межъязыковые ссылки
Смотрите раздел Help:Интернационализация#Межъязыковые ссылки.
Интервики-ссылки
Так называемые интервики-ссылки используются для упрощения создания ссылок на страницы во внешних вики-сайтах, например, Википедии. Интервики-ссылки оформляются точно так же, как и обычные ссылки, за тем испключением, что к названию страницы прибавляется префикс внешнего вики-сайта.
Например, вместо прямой ссылки на страницу в Википедии wikipedia:Arch Linux, вы можете указать просто:
[[Wikipedia:Arch Linux]]
Где Wikipedia — зарегистрированный в ArchWiki префикс сайта Википедии.
Точно так же вы можете указать собственный текст ссылки, например, статья Arch Linux в Wikipedia:
[[Wikipedia:Arch Linux|статья Arch Linux в Wikipedia]]
См. mw:Help:Links#Interwiki links.
Список всех интервики-ссылок, доступных в ArchWiki, можно посмотреть на странице Special:Interwiki и через API.
[[Wikipedia:ru:Arch Linux]]в результате чего получится такая ссылка: Wikipedia:ru:Arch Linux. Это работает для Википедии, но может не работать в точности так или не работать вообще с другими вики-сайтами.
Внешние ссылки
Если вы хотите добавить ссылку на внешний сайт, просто напишите полный URL-адрес страницы:
https://archlinux.org/
Часто бывает полезно указать собственный текст ссылки вместо отображаемого URL. Для этого укажите URL в квадратных скобках, а текст ссылки укажите сразу после URL, отделив его пробелом (не вертикальной чертой!). Например:
[https://archlinux.org/ Arch Linux]
Также можно создать автоматически нумерованную ссылку, просто заключив URL в одинарные квадратные скобки. Это часто предпочтительнее фраз типа «см. здесь». Чтобы получить фразу «см. [1]», где номер будет меняться в зависимости от порядка ссылки на странице, просто напишите:
см. [https://archlinux.org/]
- При ссылках на другие страницы ArchWiki (т.е. ссылки, начинающиеся с https://wiki.archlinux.org/) используйте внутренние ссылки. При ссылках на страницы Википедии (т.е. ссылки, начинающиеся с https://en.wikipedia.org/) используйте интервики-ссылки.
- При ссылках на задачи на gitlab.archlinux.org используйте шаблон
Template:Issue. - При ссылках на пакеты или группы пакетов используйте соответствующий шаблон. См. Help:Стиль#Инструкции по управлению пакетами.
Перенаправления
Чтобы автоматически перенаправлять пользователей с одной страницы на другую, добавьте #REDIRECT и внутреннюю ссылку на целевую страницу в начало страницы. Например, для перенаправления со страницы «Кошки» на «Кот»:
#REDIRECT [[Кот]]
Таким образом, при вводе любого из вариантов в строке поиска пользователь автоматически попадёт на страницу «Кот».
Перенаправления также позволяют отслеживать причины создания ссылок, например группируя их на страницах «Ссылки сюда», и дают возможность быстро обновлять фрагменты ссылок при переименовании разделов. Недостатком является то, что перенаправления не показывают конечный целевой адрес в браузере.
Перед созданием перенаправления вы можете выполнить поиск для проверки существующих совместимых. Например, Xorg.
Также смотрите Help:Стиль#Страницы перенаправления и Help:Procedures#Deal with talk pages after redirecting a page to another.
- Перенаправления не должны вести на другие сайты.
- Перенаправления не работают для страниц категорий.
- Перенаправления выполняются на сервере и не замедляют открытие страниц.
- Создание перенаправления из существующей страницы может привести к появлению двойных перенаправлений: смотрите Help:Procedures#Fix double redirects для их исправления.
Переменные вики, волшебные слова и шаблоны
В код страницы могут быть включены специальные волшебные слова, управляющие её отображением. Например, слово __NOTOC__, добавленное в любое место в коде, предотвращает генерирование блока содержания. Аналогичным образом, слово __TOC__ может быть использовано, чтобы указать нужное вам место расположения блока содержания. Подробнее см. Справка:Волшебные слова.
Шаблоны и переменные представляют собой заранее заданные фрагменты вики-текста, которые можно вставлять в статью для улучшения форматирования.
Переменные определяются системой и могут использоваться для отображения информации о текущей странице, вики или дате. Например, код {{SITENAME}} отобразит название сайта (здесь: "ArchWiki"). Чтобы задать альтернативный заголовок страницы, можно использовать другую вики-переменную: {{DISPLAYTITLE:Новый заголовок}}. (Однако это очень ограничено: разрешается только изменить первую букву на строчную и заменить пробелы на подчёркивания — нормализованная строка заголовка должна совпадать с реальным именем страницы, иначе ничего не выйдет; чтобы вывести заголовок с первой строчной буквы, используйте шаблон {{Lowercase title}}.)
Шаблоны, в свою очередь, определяются пользователями. Содержимое любой страницы может быть включено в другую страницу путём добавления {{Пространство имён:Название страницы}} в статью, но это редко используется со страницами вне пространства имён Template. (Если пространство имён опущено, подразумевается Template.) Например, Template:Note (Русский) можно включить в статью следующим кодом:
{{Note (Русский)|Это заметка.}}
Результат:
Подробнее см. Help:Шаблон, а также список других доступных шаблонов, вроде Template:Совет и Template:Warning.