Help:Editing (Русский)
ArchWiki использует MediaWiki — пакет свободного программного обеспечения, написанный на PHP и изначально разработанный для Википедии. Подробную информацию о MediaWiki вы найдёте на страницах Справка:Содержание в MediaWiki и Википедия:Справка.
Перед вами краткое руководство по редактированию ArchWiki. Прежде чем редактировать или создавать страницы, познакомитесь с общими характером, разметкой и стилем существующих статей. Необходимо стремиться поддерживать качество и единый стиль вики-статей. Общие правила перечислены в статьях ArchWiki:Внесение вклада, Help:Стиль и Help:Чтение. Для экспериментов можно использовать песочницу. Краткую информацию о вики-разметке вы найдёте на странице Help:Шпаргалка.
Создание аккаунта
Для внесения правок на страницы ArchWiki необходимо создать аккаунт; чтобы ответить на вопрос-капчу, потребуется обновлённое до последней версии окружение Arch Linux. Пользователи других дистрибутивов также могут править ArchWiki, для ответа на капчу они могут, например, загрузить live-окружение Arch c помощью последней версии установочного образа.
После создания аккаунта выполните вход на странице Special:UserLogin.
Редактирование
Чтобы начать вносить изменения на странице, выберите вкладку "править" наверху. Вы можете также редактировать конкретный раздел на странице, нажав на ссылку "править" справа от его заголовка. После этого появится страница Редактирование, которая состоит из следующих элементов:
- панель инструментов для редактирования (необязательно);
- поле редактирования;
- поле Описание изменений;
- ссылки Записать страницу, Предварительный просмотр, Внесенные изменения и Отменить.
Поле редактирования будет содержать викитекст текущей версии статьи или раздела — редактируемый исходный код, из которого сервер создает web-страницу. Чтобы выполнить редактирование:
- Измените викитекст как вам нужно (подробнее в разделе #Форматирование).
- Кратко объясните ваши изменения в поле Описание изменений (например, "исправлена опечатка" или "добавлена информация о xyz").
- Старайтесь всегда использовать кнопку Предварительный просмотр, чтобы проверить форматирование перед сохранением.
- Если правка не вносит смысловые изменения в содержимое (например, вы исправили только форматирование), отметьте ее как незначительную, установив флажок Малое изменение.
- Сохраните изменения, нажав на кнопку Записать страницу. Если вы передумали вносить изменения, нажмите Отменить.
Отмена правок
Изменения должны улучшать содержимое страницы. Если какая-то правка наоборот, ухудшает содержимое или просто сделана по ошибке, следующие шаги помогут вам правильно ее отменить:
- Выберите вкладку история наверху страницы (рядом с вкладкой править). Вы увидите список изменений на странице.
- Найдите неверную правку и кликните по ссылке отменить напротив нее. Вы увидите предварительный просмотр, показывающий текущую версию (слева) и текст для сохранения (справа).
- В поле описания изменений укажите причину, почему вы отменяете правку.
- Если все правильно, нажмите на кнопку Записать страницу внизу страницы.
После этого страница будет возвращена в изначальное состояние.
Иногда необходимо отменить сразу несколько последних правок за раз. Для этого:
- Выберите вкладку история наверху страницы (рядом с вкладкой править). Вы увидите список изменений на странице.
- Найдите версию, до которой вы хотите отменить все изменения (то есть, последнюю хорошую версию). Нажмите на соответствующую ей временную метку. Вы увидите выбранную версию страницы.
- Если все правильно, нажмите на вкладку править вверху страницы. Вы увидите предупреждение: Вы редактируете устаревшую версию данной страницы.
- В поле описания изменений скопируйте временную метку версии (отображается наверху) и укажите причину, почему вы отменяете последние правки.
- Теперь просто нажмите на кнопку Записать страницу, чтобы откатить все изменения до выбранной версии.
После отмены правок будет создана новая правка, которую вы сможете увидеть в истории изменений страницы.
Создание страниц
Прежде чем создавать новую страницу, пожалуйста, ответьте на следующие вопросы:
- Относится ли ваша тема к 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:Какая-либо категория]]на самом верху страницы.
На этом этапе новая страница всё ещё считвается страницей-сиротой. Чтобы завершить процесс создания, добавьте в другие статьи ссылки на неё. Это повысит её "видимость" и, возможно, побудит других пользователей внести свои улучшения. В первую очередь подумайте о страницах связанных с вашей статьё программ, обзорных статьях и различного рода списках вроде Список приложений.
В некоторых случаях имеет смысл вместо написания отдельной стать создать подстраницу, т.е. "потомка" другой страницы: заголовок подстраницы отделяется от основной страницы символом слэша . Это можно использовать для работы с черновиками статей в пространстве страницы вашего профиля, например .
Форматирование
Везде, где это возможно, форматирование текста производится при помощи вики-разметки, так что вам не придется изучать HTML. Различные шаблоны также доступны для распространенных задач форматирования: подробнее смотрите на странице Help:Шаблон. Help:Шпаргалка резюмирует наиболее распространенные опции форматирования.
Заголовки и подзаголовки
Заголовки и подзаголовки являются простым способом организовать содержимое статьи. Если вы можете выделить в тексте несколько отдельных тем, разделите их, создав для каждой из них свой раздел. Страницы Help:Стиль#Заголовки разделов и Help:Эффективное использование заголовков помогут вам сделать это правильно и придумать разделам подходящие названия.
Всего предусмотрено 6 уровней разделов, которые позволяют упорядочить текст в иерархическую структуру и оформить для них блок оглавления со ссылками на разделы. Для содержимого статьи вам доступны все заголовки начиная со второго уровня; они создаются следующим образом:
== Заголовок второго уровня == === Заголовок третьего уровня === ==== Заголовок четвертого уровня ==== ===== Заголовок пятого уровня ===== ====== Заголовок шестого уровня ======
Если в статье имеется хотя бы четыре заголовка, автоматически будет сгенерирован блок оглавления. Если вы этого не желаете, поместите специальное слово в начале статьи. Попробуйте создать несколько заголовков на странице Песочница и посмотрите на результат в содержании.
Переносы строк
Пустая строка в коде страницы используется для разделения текста на абзацы. Обратите внимание, что текст на двух соседних строках воспринимается как один абзац.
Для ручной вставки переносов вы можете использовать HTML-тег , однако этого следует избегать везде, где возможно. Его использование необходимо только при совмещении с некоторыми другими элементами разметки, например, списками.
| викитекст | результат |
|---|---|
Это предложение разделено на три строки. |
Это предложение разделено на три строки. |
Абзац номер один. Абзац номер два. |
Абзац номер один. Абзац номер два. |
* Так можно оформить пункт списка <br> на нескольких строках
* Однако, обычный перенос строки
заканчивает список |
заканчивает список |
Смотрите статью Help:Стиль/Пробелы для получения дополнительной информации об использовании пробельных символов в исходном коде страниц.
Полужирный и курсив
Полужирный шрифт, курсив и полужирный курсив добавляются путем заключения слова или фразы в два, три или пять апострофов ():
| викитекст | результат |
|---|---|
|
курсив | |
|
|
полужирный |
|
полужирный и курсив | |
Зачеркнутый текст
Используйте зачеркнутый текст, чтобы стилистически отобразить, что какое-то утверждение перестало быть истинным или стало бесполезным.
| викитекст | результат |
|---|---|
<s>Зачеркнутый текст</s> |
|
Списки
Помните, что синтаксис wiki не поддерживает многострочные элементы списков: использование "Enter" в конце строки означает конец элемента списка. Чтобы начать с новой строки внутри элемента, используйте тег . Чтобы создать многострочный блок с кодом внутри элемента, используйте Template:bc и окружите содержимое тегом . Смотрите также статьи Help:Стиль/Пробелы и Help:Шаблон.
Маркированные списки
Маркированные списки не указывают наличие строгого порядка следования пунктов. Они используются главным образом для перечисления чего-либо и подходят в большинстве случаев.
Чтобы вставить маркер, используйте звездочку (). Вы можете создавать вложенные списки, используя несколько звездочек .
| викитекст | результат |
|---|---|
* Первый пункт * Второй пункт ** Подпункт * Третий пункт |
|
Нумерованные списки
Пунктам нумерованных списков присваиваются номера, таким образом обозначая, что порядок их следования важен.
Чтобы создавать нумерованные списки, используйте знак номера или символ решетки (). Вы можете создавать вложенные списки, используя несколько таких символов .
| викитекст | результат |
|---|---|
# Первый пункт # Второй пункт ## Подпункт # Третий пункт |
|
# Первый пункт # Второй пункт #* Подпункт # Третий пункт |
|
Списки определений
Списки определений создаются с помощью точки с запятой () и двоеточия (), следующего за термином.
| викитекст | результат |
|---|---|
Списки определений: ; Клавиатура: устройство ввода с кнопками или клавишами. ; Мышь: указательное устройство для двумерного ввода. или ; Клавиатура : устройство ввода с кнопками или клавишами. ; Мышь : указательное устройство для двумерного ввода. |
Списки определений:
или
|
Используйте дополнительные двоеточия, если термин имеет несколько значений: ; Термин : первое значение; : второе значение. |
Используйте дополнительные двоеточия, если термин имеет несколько значений:
|
Списки определений не должны использоваться только для форматирования, смотрите Примеры от W3C.
Отступы
Чтобы сделать отступ в тексте, поместите двоеточие () в начале строки. Чем больше двоеточий вы поставите, тем дальше текст на этой строке в коде будет сдвинут. Новая строка отмечает окончание сдвинутого абзаца.
| викитекст | результат |
|---|---|
Этот текст вовсе не сдвинут. :Этот текст немного сдвинут. ::Этот текст чуть более сдвинут. |
Этот текст вовсе не сдвинут.
|
Код
Чтобы добавить блок кода в wiki, используйте один из шаблонов форматирования кода. Также вы можете просто начинать каждую строку с единичного пробела, например:
$ echo Hello World
Смотрите также Help:Стиль#Форматирование кода.
Таблицы
При правильном использовании таблицы могут помочь организовать большое количество данных в наглядном виде. Разметка таблиц является несколько сложной темой, которую не может покрыть данный раздел. За более подробной информацией о вики-таблицах обратитесь к руководству Wikipedia:ru:Википедия:Оформление таблиц.
| викитекст | результат | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{| class="wikitable"
|+ Табличные данные
! Дистрибутив !! Цвет
|-
| Arch || Синий
|-
| Gentoo || Фиолетовый
|-
| Ubuntu || Оранжевый
|}
|
| ||||||||||||||||||
| |||||||||||||||||||
Ссылки
Ссылки необходимы, чтобы помочь читателям перемещаться по сайту. Главным образом от редакторов статей требуется, чтобы она содержала ссылки на другие вики-страницы (во избежание появления "тупиковых" страниц), а также сама была доступна по ссылкам с других страниц (вы можете использовать специальную страницу Ссылки сюда для поиска таких ссылок).
Внутренние ссылки
Вы можете делать очень много перекрестных ссылок в вики, используя внутренние ссылки. Чтобы создать ссылку на другую страницу в той же wiki, просто возьмите ее название в двойные квадратные скобки.
Например, ссылка на статью pacman (Русский) в тексте будет выглядеть так:
[[pacman (Русский)]]
Если вы хотите использовать слова, отличные от заголовка статьи, в качестве текста ссылки, вы можете добавить альтернативное имя после символа .
Например:
[[ArchWiki:About (Русский)|ArchWiki]] является основным источником документации по Arch Linux в сети.
Результат:
- ArchWiki является основным источником документации по Arch Linux в сети.
Вы можете также воспользоватсья возможностью добавления окончаний к последнему слову в ссылке (вроде "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.
- Когда требуется явное указание пространства имен в ссылке, эта возможность позволяет автоматически убрать префикс пространства имен из текста ссылки. Например, викитекст будет заменен на About, а — на Help:Pipe trick.
Когда вы сохраняете страницу, все ссылки с пайпом в конце заменяются на ссылки с текстом, который вычисляется по специальным правилам на основе самой ссылки. При этом изменяется сам исходный код страницы. Смотрите подробнее на странице Wikipedia:Help:Pipe trick.
Межъязыковые ссылки
Смотрите раздел Help:Интернационализация#Межъязыковые ссылки.
Интервики-ссылки
Так называемые интервики-ссылки используются для упрощения создания ссылок на страницы во внешних вики-сайтах, например, Википедии. Интервики-ссылки оформляются точно так же, как и обычные ссылки, за тем испключением, что к названию страницы прибавляется префикс внешнего вики-сайта.
Например, вместо прямой ссылки на страницу в Википедии wikipedia:Arch Linux, вы можете указать просто:
[[Wikipedia:Arch Linux]]
Где — зарегистрированный в ArchWiki префикс сайта Википедии.
Точно так же вы можете указать собственный текст ссылки, например, статья Arch Linux в Wikipedia:
[[Wikipedia:Arch Linux|статья Arch Linux в Wikipedia]]
Список всех интервики-префиксов, зарегистрированных в ArchWiki, можно посмотреть по ссылке https://wiki.archlinux.org/api.php?action=query&meta=siteinfo&siprop=interwikimap&format=xml (формат XML). Как и везде, кроме первой буквы имена префиксов чувствительны к регистру.
[[Wikipedia:ru:Arch Linux]]в результате чего получится такая ссылка: Wikipedia:ru:Arch Linux. Это работает для Википедии, но может не работать в точности так или не работать вообще с другими вики-сайтами.
Внешние ссылки
Если вы хотите добавить ссылку на внешний сайт, просто напишите полный URL-адрес страницы:
http://www.google.com/
Часто бывает полезно указать собственный текст ссылки вместо отображаемого URL. Для этого укажите URL в квадратных скобках, а текст ссылки укажите сразу после URL, отделив его пробелом (не вертикальной чертой!). Например:
[http://www.google.com/ Поисковая машина Google]
Результат: Поисковая машина Google.
Перенаправления
Страницы-перенаправления позволяют создавать дополнительные имена для основной страницы, которые можно использовать в ссылках.
Страницы-перенаправления должны содержать единственную строку с директивой , за которой через пробел должна быть указана ссылка на основную страницу.
Например, вы можете создать перенаправление со страницы "Кошки" на страницу "Кот":
#REDIRECT [[Кот]]
Таким образом, если в поле поиска указать один из двух вариантов — "Кот" или "Кошка", вы автоматически попадете на страницу "Кот".
Перенаправления также помогают отслеживать причину создания ссылок, объединяя последние в группы на странице "Ссылки сюда". Это позволяет быстро исправить большое количество ссылок, например, при изменении названия раздела, на который указывает перенаправление — достаточно лишь его отредактировать. В противном случае пришлось бы исправлять каждую ссылку по отдельности. В качестве обратной стороны медали можно назвать то, что при наведении в браузере указателя на ссылку-перенаправление не отображается полный адрес цели.
Перед созданием перенаправления стоит проверить, нет ли уже подходящего. Пример: перенаправления на страницу Xorg (Русский).
Также смотрите Help:Стиль#Страницы перенаправления и Help:Procedures#Deal with talk pages after redirecting a page to another.
Волшебные слова, переменные и шаблоны
В код страницы могут быть включены специальные волшебные слова, управляющие ее отображением. Например, слово , добавленное в любое место в коде, предотвращает генерирование блока содержания. Аналогичным образом, слово может быть использовано, чтобы указать нужное вам место расположения блока содержания. Подробнее см. Справка:Волшебные слова.
Шаблоны и переменные представляют собой специальные участки вики-текста, который позволяет улучшить форматирование страниц.
Переменные, как правило, используются для вставки в текст определенного динамического содержимого. Например, на месте , будет отображено имя вики-сайта (на нашем сайте это ""). Переменная DISPLAYTITLE несколько отличается — она используется для управления отображением заголовка страницы: . (Правда, это работает очень ограниченно — вы можете менять лишь регистр первой буквы и заменять пробелы символами подчеркивания, то есть, нормализованный заголовок должен совпадать с реальным названием страницы. Используйте шаблон , чтобы выводить название страницы с первой буквой в нижнем регистре.)
Наличие и возможности той или иной переменной устанавливаются системой. Шаблоны, с другой стороны, могут создаваться и изменяться пользователями сайта. Их содержимое можно включать в любое место страницы.
Обобщая, содержимое любой страницы может быть включено в другую страницу добавлением в статью. Однако, чаще всего таким образом на страницы включаются именно шаблоны (которые являются страницами из пространства имен "Template"). При включении шаблонов, вы можете опустить пространство имен: например, Template:Note (Русский) можно включить в статью следующим кодом:
{{Note (Русский)|Это заметка.}}
Результат:
Подробнее см. Help:Шаблон, а также список других доступных шаблонов, вроде Template:Совет и Template:Примечание.