Help:Wiki_structure описывает как устроена вики, а также правила именования страниц.
Страница Help:Editing на Mediawiki.org -- хороший источник информации по вики разметке. Справочная карта также является отличным источником информации.
Вики Проекта Fedora предъявляет лишь незначительные требования для получения доступа для редактирования. Однако необходимо ознакомиться с некоторыми правилами редактирования, прежде чем начать использовать вики, и этим правилам должны следовать все редакторы. На этой странице приведены эти принципы, а также несколько советов, которые помогут вам приступить к работе.
Этот документ разделен на три части: получение доступа к редактированию, основы вики разметки, дополнительная информация по вики разметке.
- Страницы на русском
Получение доступа к редактированию
Во избежание влияния пользователей, которые умышленно портят Вики Проекта Fedora, мы вынуждены немного ограничить доступ к ее редактированию. Для получения прав доступа к Вики необходимо сделать несколько действий. Не беспокойтесь, любой желающий может получить доступ.
- Ознакомьтесь с информацией на этой и других страницах, на которые она ссылается.
Основные правила, которые следует соблюдать, приведены здесь. Игнорирование этих принципов создает ненужную работу для других участников и в результате может привести к отзыву прав редактирования.
- Примите CLA (Лицензионное Соглашение Участника) через систему учетных записей Fedora .
Это даст Проекту Fedora возможность безоговорочно лицензировать ваш вклад в Вики согласно лицензии OPL 1.0. Это гарантирует, что ваш вклад останется свободным для общественного использования, изменения и распространения, аналогично дистрибутиву Fedora. Обратитесь к разделу Legal для получения дополнительной информации. Следуйте инструкциям по принятию соглашения на странице http://fedoraproject.org/wiki/Infrastructure/AccountSystem/CLAHowTo
Если вы заинтересованы в поддержке веб-сайта или хотите влиться в команду Интернет-ресурсов Fedora, перейдите на страницу Ru_RU/Websites.
Информация по созданию официальной документации Fedora с помощью вики доступна на странице Создание вики-документации.
Если вы заинтересованы в переводе вики на русский язык, перейдите на страницу переводов вики, где координируются усилия русской команды
Правила
Существует несколько простых правил, которых необходимо придерживаться при редактировании вики. Ниже рассмотрено несколько примеров. В двух словах, будьте вежливы и пользуйтесь здравым смыслом. Игнорирование этих правил и умышленное создание проблем гарантирует запрет доступа редактирования. Если у вас возникли вопросы, их можно задать в канале IRC #fedora-websites на freenode .
Представьтесь
Прежде чем начать редактирование любой страницы, хорошо бы представиться, поэтому добавьте информацию о себе на свою вики-страницу. При регистрации в Вики будет автоматически создана ваша персональная страница http://fedoraproject.org/wiki/User:<ВикиИмя>, где <ВикиИмя> -- ваше имя в системе учетных записей Fedora. К персональной странице можно перейти в любое время, нажав на своем имени в правом верхнем углу страницы.
Некоторые примеры вики-страниц наших участников можно просмотреть здесь.
Убедительная просьба перенести существующие старые страницы с именами ИмяФамилия из Мoin в новый формат MediaWiki. Если вы совсем недавно подключились к Проекту Fedora и где-то заметили инструкции о создании персональной страницы в формате ИмяФамилия, пожалуйста, сообщите об этом участнику Ian Weller
Убедитесь, что на персональной странице указан как минимум адрес электронной почты и, если вы используете IRC, ваше имя в IRC и каналы, где вас можно найти.
Всегда подписывайтесь на страницы, которые вы создаете или редактируете
Важно, чтобы вы следили за изменениями страниц, которые вы создали или изменили; таким образом вы можете координировать свои усилия с другими участниками, работающими с вики. Редакторы обычно добавляют заметки при изменении страниц для передачи информации друг другу, и это помогает отслеживать изменения.
В список наблюдения страницу можно добавить на вкладке "Следить" вверху страницы, которая будет доступна после авторизации.
Правьте смело
Не стесняйтесь вносить изменения. Изменения вики отслеживаются и могут быть восстановлены в случае необходимости. Однако это не значит, что можно необдуманно вносить кардинальные изменения в ключевые документы.
Более подробную информацию можно найти в Википедии.
Избегайте ненужного редактирования страниц, обсуждающих правовые вопросы
Эти страницы писались основательно, а слова тщательно подбирались. Прежде чем изменять эти документы, обычно лучше посоветоваться со специалистами. За помощью можно обратиться в Консультативный Совет Fedora (Fedora Advisory Board) (см. страницу Board).
Не публикуйте информацию запрещенного содержания
Не добавляйте информацию, которая преследуется законом. Помните, Проект Fedora управляется из США и регулируется законодательством США. Избегайте добавления ссылок и информации о программном обеспечении, которое не является свободным и открытым, так как это может накладывать дополнительные обязательства. Если вы хотите добавить информацию в виде исключения, обсудите это с командой Интернет-ресурсов . Страница Запрещенные элементы содержит примеры, которых следует избегать.
Команда Интернет-ресурсов даст вам официальный ответ по поводу добавления информации такого рода.
Соблюдайте осторожность при редактировании ключевых руководств и страниц
Основополагающие правила, такие как руководящие принципы создания пакетов , обычно управляются конкретными людьми или группами. Если, по вашему мнению, такие страницы нуждаются в обновлении, свяжитесь с соответствующей группой.
Важные страницы, такие как главная страница или Загрузка, являются первыми страницами, которые многие посетители увидят. Предоставьте изменение таких опытным участникам. Если вы считаете, что такая страница должна быть изменена, вынесите свое предложение на обсуждение командой Интернет-ресурсов.
Не редактируйте страницы просто чтобы редактировать
Следует избегать бессмысленных изменений. Внесение изменений в текст страницы, только для того чтобы поместить свое имя в журнал изменений недопустимо. Есть множество страниц, скорее даже, большинство, с существующими ошибками, которые нужно исправить. Вместо того чтобы делать бессмысленные изменения, такие как добавление пробелов или изменение ссылок с fedoraproject.org на www.fedoraproject.org (кстати, первая предпочтительней), попробуйте найти ошибки в орфографии, грамматике или пунктуации, которые можно исправить. Кроме того, при исправлении мелких ошибок помечайте редактирование как "Малое изменение", используя соответствующий флажок внизу страницы.
Избегайте переименования страниц или перемещения содержимого без координации
Вики страницы в основном ссылаются на другие страницы и связаны с различными адресами. Важно координировать с командой перенос и переименование существующих страниц. Лучше избегать переноса без серьезного обоснования. Если вы хотите обсудить перемещение материала, вынесите свои предложения на рассмотрение командой Интернет-ресурсов.
Удаление страниц
Страницам, в которых больше нет необходимости, можно присвоить специальную метку удаления, добавив в ее начало {{Delete|Reason}}, предоставив тем самым администраторам гарантию, что эта страница действительно больше не нужна.
Следуйте идеалам, которые Fedora считает важными
Например, старайтесь не рекомендовать конкретное окружение рабочего стола, особенно начинающим пользователям Linux и Fedora. Пользователи сами должны выбрать предпочитаемое окружение, будь то GNOME, KDE, консоль или другая среда. Старайтесь помнить об этом при написании инструкций. Постарайтесь, чтобы ваши страницы отражали приверженность Fedora принципам свободного и открытого обеспечения.
Подписывайте вложенные файлы
Когда вы добавляете файл в вики-страницу, создайте подпись с помощью своего GPG-ключа. Некоторые форматы файлов, такие как RPM-пакеты, поддерживают GPG-ключи, и в этом случае подпись создавать необязательно, так как файл уже будет ее содержать. Подпись можно присоединить к странице вместе с исходным вложением или добавить в саму страницу.
GPG-подпись позволит пользователям, загружающим файл, убедиться, что он поступил именно от вас и не был изменен или поврежден. Наличие подписи ни в коем случае не нарушает ваших прав на конфиденциальность, это лишь позволяет другим пользователям убедиться в достоверности просхождения файлов.
Изображения и простые документы можно оставить без подписи, в то же время, при ее добавлении пользователи смогут удостовериться, что вы -- автор этого документа.
Если у вас нет GPG-ключа или вы хотите узнать больше об этом, см. страницу Cryptography.
Проверяйте изменения на наличие ошибок
Вне зависимости от того, являетесь ли вы опытным автором текстов или ваш английский не слишком силен, предложите другим участникам просмотреть сделанные изменения. Грамотно написанные документы важны для поддержки имиджа Fedora. Даже самые лучшие авторы не застрахованы от опечаток и других ошибок. Выделите время, чтобы просмотреть сделанные изменения и исправить мелкие ошибки.
Fedora -- это сообщество
При написании документов для вики или других ресурсов, помните, что Fedora является сообществом. "Мы" являемся единой группой с общими целями. "Мы" не отличаем одну группу и не классифицируем их. Например, нет необходимости проводить различия между добровольцами, которые работают в Red Hat, и теми, кто не делает этого. Все добровольцы являются частью одного сообщества. Однако существуют случаи, когда классификация необходима, в противном случае этого следует избегать.
Если вы в чем-то не уверены, просто спросите
Другие члены сообщества будут рады вам помочь. Канал #fedora-websites freenode является идеальным местом для обсуждения Вики и других сайтов Fedora. Если же у вас есть вопросы по переводам, их лучше задать в канале #fedora-l10n, рассылке fedora-trans-ru (на русском) или fedora-trans-list (на английском).
Следите за своими страницами, а также страницами других участников
Две вещи позволяют Вики быть успешным инструментом по совместному использованию открытого содержимого. Первая: возможность просмотра содержимого, за которое вы несете ответственность, чтобы убедиться, что оно соответствует действительности. Вторая: возможность отслеживания материалов других авторов с целью поддержки и помощи.
В список наблюдения страницу можно добавить на вкладке "Следить" вверху страницы, которая будет доступна после авторизации. После добавления ссылка изменится на "Не следить". Нажав ее повторно, вы удалите страницу из своего списка наблюдения.
Также можно настроить почтовые уведомления об изменении страниц. Для этого перейдите на страницу настройки (выбрав одноименный пункт меню вверху страницы) и на вкладке Личные данные, в секции Электронная почта, установите соответствующие флажки.
Страница Special:Watchlist
На странице Special:Watchlist, доступ к которой можно получить, нажав список наблюдения вверху страницы, показаны все отслеживаемые вами страницы. Подробную информацию об этой странице можно найти в справке Mediawiki.org.
Теперь мы поддерживаем отдельную страницу советов по списку наблюдения, которая содержит информацию о различных методах отслеживания страниц.
Правило: Заполняйте описание изменений
Нам всем хотелось бы иметь возможность легко получить представление о сделанных другими участниками изменениях. Настоятельно рекомендуется заполнять поле Описание изменений под окном правки страницы. Вкратце объясните, что именно вы сделали и почему.
По большому счету, описание не должно игнорироваться. Исключение составляют незначительные изменения, в случае чего при сохранении страницы не забудьте установить флажок "Малое изменение".
Редактирование с помощью Mediawiki
Основной синтаксис
| Введенный текст | Выглядит так |
|---|---|
'''жирный шрифт''' |
жирный шрифт |
''курсив'' |
курсив |
'''''жирный курсив''''' |
жирный курсив |
<code>моноширинный шрифт</code> |
моноширинный шрифт
|
Списки
| Введенный текст | Выглядит так |
|---|---|
* Элемент списка * Другой элемент списка ** Элемент вложенного списка |
|
# Элемент пронумерованного списка # Другой элемент пронумерованного списка ## Первый элемент вложенного упорядоченного списка ## Второй элемент вложенного упорядоченного списка # Третий элемент пронумерованного списка |
|
* Элемент неупорядоченного списка... *# ... с вложенным упорядоченным списком *# продолжение упорядоченного списка * Второй элемент неупорядоченного списка *# Новый упорядоченный список *#* ... с собственным вложенным списком |
|
Ссылки
| Введенный текст | Выглядит так |
|---|---|
Перейдите на страницу [[L10N/Teams/Russian| русской команды]] для получения информации о переводе Fedora на русский язык. |
Перейдите на страницу русской команды
для получения информации о переводе Fedora на русский язык. |
На странице [[Ru_RU/MonthlyTasks]] можно просмотреть список задач на следующий месяц. |
На странице Ru_RU/MonthlyTasks можно просмотреть
список задач на следующий месяц. |
Прочитайте инструкции [[Ru_RU/L10N/Glossary#Instruction]] по добавлению новых терминов в словарь. |
Прочитайте инструкции Ru_RU/L10N/Glossary#Instruction
по добавлению новых терминов в словарь. |
Страница [[Погода в Москве]] не существует. |
Страница Погода в Москве не существует. |
http://fedoraproject.org/ |
http://fedoraproject.org/ |
Ссылки на сайты: [http://www.russianfedora.ru/] [http://www.flickr.com] |
Ссылки на сайты: [1] [2] |
[http://fedoraproject.org Домашняя страница] Проекта Fedora. |
Домашняя страница Проекта Fedora. |
Добавьте ':' для ссылки на [[:Image:Growth_wide.jpg|изображение]]. |
Добавьте ':' для ссылки на изображение. |
[[:Category:LocalizationRussian]] содержит список всех страниц на русском языке. |
Category:LocalizationRussian содержит список всех страниц на русском языке. |
Добавьте [[Category:LocalizationRussian]] в конец страницы, чтобы добавить ее в список русских страниц. |
Добавьте [[Category:LocalizationRussian]] в конец страницы,
чтобы добавить ее в список русских страниц. |
Укажите двоеточие перед словом "Category" при создании ссылки на страницу категории. Если страница уже принадлежит этой категории, двоеточие можно опустить (см. примеры выше).
Таблицы
Таблицы должны использоваться лишь при необходимости.
Подробную информацию о работе с таблицами можно найти на сайте Mediawiki.org.
| Структура | Текст ввода |
|---|---|
| Начало таблицы | {|
|
| Заголовок таблицы | ! Столбец 1 !! Столбец 2 !! Столбец 3 |
| Строка таблицы | |- |
| Данные таблицы | | Ячейка 1 || Ячейка 2 || Ячейка 3 |
| Конец таблицы | |} |
Текст IRC
Для выделения вывода IRC используйте теги <pre> или преобразуйте его стиль в таблицу с помощью irclog2html и исправления для irclog2html.
Структура вики-страниц
Этот раздел описывает общую структуру вики-страниц. Придерживайтесь этих указаний при создании и правке вики-страниц. Существуют дополнительные правила для официальной документации Fedora, описанные на странице DocsProject/WritingUsingTheWiki ; эти правила позволяют следовать правилам оформления содержимого при документировании Fedora .
Заголовок страницы является заголовком первого уровня. При создании и переносе страниц убедитесь, что они содержат ТОЛЬКО заголовки второго уровня.
- Заголовок страницы является заголовком первого уровня и создается автоматически.
- Для форматирования секций используйте знаки равенства:
== Заголовок 2 == === Заголовок 3 === ==== Заголовок 4 ==== ===== Если требуется 5 уровней вложения, лучше создать новую страницу =====
- Содержание страницы генерируется автоматически и заполняется по ходу наполнения страницы.
- Якоря для секций также генерируются автоматически. При этом пробелы и знаки препинания заменяются специальными символами:
Моя страница ==> Моя_страница Страница про одно, второе и немного третьего ==> Страница_про_одно,%2C_второе_и_немного_третьего
При создании якоря для секции можно заменить '%' на точку.
Советы
Здесь приведены основные правила, которых стоит придерживаться при редактировании Вики.
о создании вики-документации рассказывается здесь.
Учитесь на примерах
Одним из лучших способов изучить способы редактирования вики-страниц является просмотр исходного кода уже существующих страниц. Это очень просто сделать:
- Найдите страницу, исходный код которой хотите просмотреть.
- Вверху страницы нажмите править.
Будет показан текст этой страницы. Это особенно ценно при изучении некоторых трюков, уже использующихся вики-авторами, что позволит применять уникальные, интересные приемы, о которых вы и не подозревали. Попробоуйте ознакомиться с кодом страницы Ru_RU (не вносите кардинальных изменений!).
Примечания, советы, и другое выделение текста
Которые в целом известны как замечания и используются в DocBook. Для преобразования текста используется специальный формат:
| Введенный текст | Выглядит так |
|---|---|
{{admon/note|Заголовок замечания|Здесь содержится подробный текст замечания.}}
|
Заголовок замечания
Здесь содержится подробный текст замечания. |
Отступ начального и второго параграфа на один пробел гарантирует, что рамка будет правильно выровнена.
Ниже приведены стандартные виды замечаний:
| Введенный текст | Выглядит так |
|---|---|
{{admon/note|Замечание|Здесь содержится подробный текст замечания.}} |
Замечание
Здесь содержится подробный текст замечания. |
{{admon/tip|Подсказка|Здесь содержится подробный текст подсказки.}} |
Подсказка
Здесь содержится подробный текст подсказки. |
{{admon/important|Важно|Здесь содержится важная информация, на которую следует обратить внимание.}} |
Важно
Здесь содержится важная информация, на которую следует обратить внимание. |
{{admon/caution|Осторожно|Здесь содержится подробная информация.}} |
.png){kind=small} Осторожно
Здесь содержится подробная информация. |
{{admon/warning|Предупреждение|Здесь содержится полный текст предупреждения.}} |
 Предупреждение
Здесь содержится полный текст предупреждения. |
Примеры замечаний
В Википедии рассказывается о высоте обрывов.
Подробную информацию можно найти на странице
cliffs(1).Дети достатчно подвижны и могут сорваться. Держите их за руку.
Как уже говорилось, высота обрывов может быть достаточно большой, а сорваться никому не хочется.
Отойдите от края во избежание падения.
Руководство по документированию Fedora содержит подробное описание типов замечаний:
http://docs.fedoraproject.org/documentation-guide/en_US/sn-xml-admon.html
Выделение технических терминов
Используйте разметку code (<code></code>), чтобы отметить имена приложений, файлов, каталогов, пакетов программ, учетных записей пользователя и других слов, которые имеют технический смысл. Это отобразит выделенный таким образом текст моноширным шрифтом.
Используйте пары одинарных кавычек (''[элемент меню]''), чтобы отметить пункты меню и другие элементы графического интерфейса. Это выделяет текст курсивом.
Элемент
Разметка
Пример форматирования
Название GUI приложения
'''полужирный'''
Firefox
Файлы, каталоги
<code>вложенные теги code</code>
/usr/bin/firefox
Пакеты программ
<code>имя пакета</code>
firefox-1.2.3
Учетная запись пользователя
<code>пользователь</code>
username
Другой технический текст
<code>технический термин</code>
someJava.classname
Графические меню и пункты меню
''меню''
Приложения > Интернет > Firefox Web Browser
Другие GUI или Веб-UI элементы
''курсив''
... нажмите кнопку Подтвердить ...
Команды и демоны
<code>параметр команды</code>
grep httpd, чтобы найти PIDs запущенных httpd процессов.
Секции кода, файлы конфигурации и т.п.
<pre>пробелы сохраняются</ pre>
здесь
пробелы сохранены
Вложенные секции кода, файлы конфигурации и т.п.
<code>пробелы не сохраняются</code>
... Затем измените переменные set() в /path/to/org/dev108/classname ...
Первый термин, термин из глоссария
''термин''
... Firefox является примерм графического интерфейса пользователя (GUI).
Комбинации клавиш
'''[Клавиша] '''
Нажмите клавишу[Enter] ...
Например:
<code>thunderbird</code> пакет устанавливает почтовый клиент '''Mozilla Thunderbird'''. Чтобы запустить '''Thunderbird''', выберите: ''Приложения > Интернет > Thunderbird Email''.
Текст будет выглядеть так:
thunderbird пакет устанавливает почтовый клиент Mozilla Thunderbird. Чтобы запустить Thunderbird, выберите: Приложения > Интернет > Thunderbird Email.
Запись примеров команд
Примеры команд содержат одну или несколько команд не считая пояснений. В тексте команд не используйте название компьютера, каталога или имени пользователя, то есть информацию из переменной окружения $PS1.
Примеры команд заключите в теги <pre></pre>:
<pre>
su -c "yum install awesome-application"
</pre>
Enter the <code>root</code> password when prompted.
Текст будет выглядеть так:
su -c "yum install super-application"
Enter the root password when prompted.
Пользователи НЕ ДОЛЖНЫ работать в режиме root
Многие команды требуют привилегий root. Пользователи не должны заходить в свою систему как root, а рекомендуется указать su -c или su - при указании административных команд.
Если текст команды содержит кавычки, вложение будет выглядеть так: " ' ' ", где одинарные кавычки заключены в двойные.
Пример:
su -c "command -o 'Какой-то текст' -file 'Еще текст' foo/bar"
При наличии целого набора команд можно предложить пользователю перейти в режим root и по завершению напомнить вернуться в обычный режим.
su -
Password:
service food stop
cp /etc/foo.d/foo.conf /etc/foo.d/foo.conf.backup
vi /etc/foo.d/foo.conf
food --test-config
...
service food start
exit
Вывод команды
Если текст демонстрирует команду как часть вывода на экран, можно добавить строку приглашения.
$ su -c "ls -l /root"
Password:
total 148
-rw------- 1 root root 1961 2007-09-21 02:46 anaconda-ks.cfg
-rw-r--r-- 1 root root 46725 2007-09-21 02:46 install.log
-rw-r--r-- 1 root root 6079 2007-09-21 02:42 install.log.syslog
-rw-r--r-- 1 root root 3699 2008-07-28 17:24 scsrun.log
-rw-r--r-- 1 root root 45038 2008-01-10 10:21 upgrade.log
-rw-r--r-- 1 root root 1317 2008-01-10 10:20 upgrade.log.syslog
Попробуйте сами
Попробуйте поэкспериментировать в "песочнице" Вики Проекта Fedora . Здесь вы можете проверить работоспособность разных примеров.
Создание новых вики-страниц
Вики Проекта Fedora доволно обширна, поэтому должна поддерживаться соответствующая иерархия и организация. Лучший способ узнать об этом -- просмотреть Help:Subpages и Help:Categories и ознакомиться с существующей структурой Вики.
Следует избегать избыточности имен (например, /Foo/FooBar/FooBarGrue). Так, включение 'Fedora' в имя страницы является излишним. Основные проекты Fedora не должны содержать слово 'Project' в своем названии. Например , Проекту Интернет-ресурсов Fedora соответствует страница 'Ru_RU/Websites', а не 'Ru_RU/Fedora
Обычно страницы должны быть сгруппированы по проектам или программам, частью которых они являются. Категории должны создаваться для различных проектов и программ и должны создаваться умеренно. Страницы, которые вы создаете, должны быть включены в категории и иметь подходящие теги. Если вы намереваетесь создать новую категорию или тег, сперва посоветуйтесь с командой Интернет-ресурсов.
Если у вас есть впоросы, свободно обращайтесь к команде Интернет-ресурсов.
Важные страницы
Ключевые страницы, такие как главная страница Проекта Fedora, следует редактировать осторожно. Изменения таких страниц должны обсуждаться в списке рассылки или на IRC. Некоторые части Вики могут иметь различные разрешения доступа. Например, Ru_RU/DocsProject включает раздел создания новой документации, доступ к которому ограничен по сравнению с остальной Вики. Чтобы получить доступ к редактированию таких страниц, необходимо выполнить дополнительные шаги. Обычно такие страницы содержат инструкции по получению доступа.
Получение помощи
Если у вас есть вопросы по редактированию Вики Проекта Fedora, или вам нужна помощь, обратитесь к участникам команды Ru_RU/Websites. У этой команды есть IRC канал и почтовая рассылка -- оба эти способа эффективны для получения ответов на ваши вопросы.
Если вы собираетесь активно редактировать Вики, рекомендуется присоединиться к команде Ru_RU/Websites.
Дополнительные ресурсы