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> |
моноширинный шрифт
|
Списки
| Введенный текст | Выглядит так |
|---|---|
* Элемент списка * Другой элемент списка ** Элемент вложенного списка |
|
# Элемент пронумерованного списка # Другой элемент пронумерованного списка ## Первый элемент вложенного упорядоченного списка ## Второй элемент вложенного упорядоченного списка # Третий элемент пронумерованного списка |
|
* Элемент неупорядоченного списка... *# ... с вложенным упорядоченным списком *# продолжение упорядоченного списка * Второй элемент неупорядоченного списка *# Новый упорядоченный список *#* ... с собственным вложенным списком |
|
Ссылки
Таблицы
Журналы IRC
Структура ВиКи страниц
Этот раздел описывает общую структуру Вики страницы. Придерживайтесь этих указаний для каждой Вики страницы. Существуют дополнтельные правила для официальной документации Федора, описанные в DocsProject/WritingUsingTheWiki ; эти правила необходимы только для писателей содержимого, чтобы следовать процедурам Fedora Documentation Project .
1. Заголовок страницы является заголовком первого уровня. Окружайте его с знаком разметки заголовка =:
= Заголовок страницы =
{{Admon/note | Исключчения | Страницы которые предполагается использовать всегда и только встроенными в другие страницы с помощью [[Inline()] -макроса, эти страницы не начинайте с заголовка первого уровня. Структура этих не модульных подстраниц зависит от родительских и начинается с вложенного уровня родительского документа.}}
1. Над разделом = Заголовок страницы = и до == Введение == , включайте макрос создающий содержание страницы :
= Заголовок страницы = == Введение ==
Нет необходимости включать содержание в страницы которые достаточно коротки, страницы которые можно прочитать без прокрутки в браузере открытом на 700 пикселей ввысоту.
Целью включения содержания является удобство читателя. Если содержание мешает при чтении, удалите его.
1. Ключевые разделы можно использовать для как "якоря" для удобного создания ссылок.(Key sections can use an anchor for prettier linking.) Использование заголовка раздела как "якорь" с подчеркиванием, делает URL легкочитаемым(Using the section title as the anchor with underscores makes for an easy to read URL.) Вне зависимости от стиля, который вы используете, будьте последовательны на протяжении всего документа.
{{Anchor|Заголовок_Раздела}}
== Заголовок Раздела ==
1. Главные страницы могут бать сгруппированы помощью сочетания Important pages can be categorizedсгруппированы by putting сочетании CategoryFoo внизу страницы над горизонтальной линией at the bottom of the page under a horizontal rule. Замените Foo на имя категории, например такой как Documentation.
---- [[Category:Documentation
]]
Простым способом сгруппировать страницы пункт меню Make this page belong to category который появляется на странице Wiki редактирования.
Страницы в Docs/Beats являются source only и не включаются в категорию страниц CategoryDocs т.к. их не предполагают отображать как результат поиска документации. Если страница является источником содержимого но не является канонической или ссылкой следуя по которой можно найти эту информацию, тогда не включайте ее в категорию. Другим примером является любое содержимое под персональным NameSpace.
1. More to come
Советы
These are the basic things that you need to know to edit this Wiki.
For more information on drafting documentation on the Wiki, refer to Writing Wiki Documentation .
Учитесь на примерах
Одним из самых лучших способов изучить способы редактирования wiki страниц является просмотр исходников существующих страниц. Это очень просто сделать:
- Найдите страницу исходники которой хотите просмотреть.
- На навигационной панели найдите combo box that reads 'More Actions:' и нажмите его.
- Выберите 'Show Raw Text'.
Wiki покажет открытый текст этой страницы. Это особенно важно для изучения некоторых трюков использующихся wiki редакторами до вас. This is particularly valuable for learning some of the clever trick s used by wiki editors ahead of you. Эти 'трюки' особенно ценны, потому что они позволяют вам делать уникальные, интересный и мощные вещи которые вы даже не считали что они возможны. Вы можете попробовать это на любой странице подобной FedoraMain.
Ссылки
Создание ссылок возможно самая простая хитрая вещь в MoinMoin. Простейщая форма создания ссылок это wiki имена. Wiki имена это комбинация двух или более заглавных слов. Когда вы используете WikiИмена, нет необходимости использовать специальную разметку. Ссылка будет создана автоматически.
Во избежания создания нежелательных ссылок, вам необходимо обзнакомиться с некоторыми хитростями. Простейший способ сделать это состоит в том чтобы поставить два backticks мжежду WikiСловами, следующим образом: Wiki, которые безопасно "ломают" wiki механизм автоматического создания ссылок слов. Если вам необходимо создать ссылку на подстраницу или на станицу которая не является wiki именем, вы можете использовать синтаксис подобно этомуСлова A Subpage of Project или просто ["Pagename"] .
Избегайте расстановки ссылок на другие веб-сайты впределах параграфа. Вместо этого сошлитесь на веб-сайт в тексте и напишите URL для ссылки в отдельной строке. Это гарантирует что URL достаточно удобочитаем при распечатке страницы или при преобразовании ее в другой формат. Например:
Просмотрите Fedora Documentation Website в поисках самой свежей версии этого документа пржде чем начать. [http://docs.fedoraproject.org/]
Для того чтобы узнать больше об этом, см. HelpOnLinking.
Списки
Нумерованные и маркированные списпи очень просты и полезны. См. HelpOnLists для более подробной информации о ток как использовать их.
Таблицы
Таблицы могут быть очень сложными, потому что они могут вести себя не так как вы ожидаете. Широкие таблицы особенно ненадежны, т.к. они будут вылазить за свои границы при просмотре в маленьком окне. Самым лучшим советом при использовании таблиц состоит в том чтобы использовать их тоглько при необходимости. Только при публикации большой последовательности маленьких записей они могут сохранить много пространства. Просто тестируйте их при использовании. Помните что одугие могут иметь более низкое разрешение чем то что используете вы. Более подробная информация изложена на странице HelpOnTables.
Примечания, советы, и другой Boxed текст
Которые в целом известны как admonitions(замечания). Чтобы превратить параграф в замечания(admonition), введите два символа вертикальной черты (pipes) вначале и в конце параграфа, сделайте заголовок bodl face, начните заголовок с подходящего значка и добавьте дополнительную информацию во второй параграф:
{{Admon/tip | Это пример заметки. | Здесь содержится дополнительная информация о заметке.}}
Здесь содержится дополнительная информация о заметке.
Отступ в начального и второго параграфа на один пробел гарантирует что бокс будет правильно выровнен.
Ниже приведены стандартные виды замечаний:
Это иконка примечаний 
Это иконка заметок 
Это иконка призывающая к осторожности 
Эта иконка о важном сообщении 
Это иконка о предупреждении
.png){kind=small}
См. Fedora Documentation Guide для описания типов замечаний:
http://fedora.redhat.com/participate/documentation-guide/s1-xml-admon.html
Выделение Технических Терминов
Используйте символ (), чтобы отметить имена приложений, файлы, директории, пакеты программы, аккаунт пользователя и другие слова, которые имеют технический смысл. Это отображает слова как .
Используйте два single-quotes () чтобы отметить имена пунктов меню и других элементов графического интерфейса. Это отображает выделенный слова как italic.
#!html
<div style="background: #eeeff1">
Высказывание
Разметка
Начертание
Пример начертания
Название GUI приложения
полужирный полужирный
Firefox
Файлы, каталоги
single backticks моноширный шрифт/usr/bin/firefox
Пакеты программ
single backticks моноширный шрифтfirefox-1.2.3
Аккаунт пользователя
single backticks моноширный шрифтusername
Другие слова которые имеют специальное техническое значение
single backticks моноширный шрифтsomeJava.classname
Inline содержание из конфигурационных файлов, листинг программ.
single backticks моноширный шрифт... Затем, измените настройки DefaultIcon в /etc/httpd/conf/httpd.conf ...
Графические меню и пункты меню
two single-ticks курсив
Приложения > Интернет > Firefox Web Browser
Другие GUI или Веб'UI элементы управления
two single-ticks курсив
... нажмите кнопку Подтвердить ...
Первый термин, словарный термин
two single-ticks курсив
... Firefox является примером graphical user interface (графический пользовательский интерфейс) or GUI.
Inline команды и демоны
3 фигурные скобки моноширный шрифтgrep httpd чтобы найти PIDs запущенных httpd процессов.
Комбинации клавиш
[Key] [bold brackets]
Нажмите клавишу[Enter] ...
#!html
</div>
Например:
<code>thunderbird</code> пакет устанавливает '''Mozilla Thunderbird''' e-mail приложение. Чтобы запустить '''Thunderbird''', выберите: ''Приложения > Интернет > Thunderbird Email''.
Которое отображает:
thunderbird пакет устанавливает Mozilla Thunderbird e-mail приложение. Чтобы запустить Thunderbird, выберите: Приложения > Интернет > Thunderbird Email.
Запись примеров команд
Примером команд является одна или последовательность команд за исключением текста пояснений.
Example commands are one or more commands set apart from the body of the explanation. Do not use prompt symbols or any other content that shows machine name, user, directory, etc. (which are details set in the $PS1 environment variable.)
Заключите любой пример команды тройными фигурными скобками, на первой строке команды три открывающие фигурные скобки и три закрывающие фигурные скобки за командой:
<pre>
su -c "yum install awesome-application"
</pre>
Enter the <code>root</code> password when prompted.
Которое отображает:
su -c "yum install awesome-application"
Enter the root password when prompted.
Пользовтели НЕ ДОЛЖНЫ работать в качестве пользователя root
Много команд требуют привилегий root(администратора). Пользователи не должны заходить в свою систему как root, и вам необходимо запускать такие команды или с помощью su -c или su -.
If the command requires elements to be quoted, nesting should be " ", with the single quote marks surrounded by one containing set of double quote marks. For example:
su -c "command -o 'Some Text' -file 'More text' foo/bar"
Попробуйте сами
Попробуйте новые вещи в Fedora Wiki "песочнице" . Здесь вы можете проверить на работоспособность много небольших примеров.
Создание Новых Станиц в Wiki
Wiki Fedora Проекта очень большая, и поэтому должна поддерживаться в соответствующая иерархия и организация. Лучший способ узнать об этом состоит в том чтобы просмотреть SubPages и HelpOnCategories, а затем просмотреть существующие разделы wiki.
Излишние имена (такие как /Foo/FooBar/FooBarGrue) не должны использоваться. Помните что включение 'Fedora' в имя страницы является излишним. Основной Fedora проект также не должен содержать слово 'Project' в своем названии. Например , Проекту Fedora Websites соответствует страница 'Websites', а не 'Fedora
В основном страницы должны быть сгруппированы по проектам или программам частью которых они являются. Категории должны создаваться для различных проектов и программ и должны создавать умеренно. Большинство страниц которые вы создаете должны быть частью категории и большинство из них должны иметь подходящий тэг. Если вы намереваетесь создать новую категорию или тэг, пожалуйста сперва посоветуйтесь с командой Websites.
Если у вас есть впоросы свободно обращайтесь с ним к команде Websites.
Важные страницы
Ключевые страницы, такие как FedoraMain (у нас сейчас FedoraPrincipal (то же самое на французском, может исправим)) следует редактировать осторожно. Изменения таких страниц должны обсуждаться в списке рассылки или на IRC прежде чем применены. Специальные страницы, такие как RecentChanges, не должны редактироваться. Некоторые части ВиКи могут иметь различные разрешения доступа (permissions). Например DocsProject имеет раздел создания новой документации которая имеет немного меньше разрешений чем другая часть ВиКи. Чтобы получить доступ к редактированию таких страниц, вам необходимо выполнить дополнительные шаги. Обычно, вы можете найти инструкции, о том как это сделать, на этих страницах.
MoinMoin имеет много важных страницы которые необходимы для его нормального функционирования. Эти страницы будут отмечены в исходниках и должны быть оставлены в покое.(These pages will generally be marked in the source and should be left alone. ) Изменение этих страниц обычно уничтожается с помощью обновления MoinMoin software.
Получение справки
Если у вас есть вопросы по редактированию Вики Проекта Fedora, или вам нужна помощь, обратитесь к участникам команды Ru_RU/Websites. У этой команды есть IRC канал и почтовая рассылка -- оба эти способа эффективны для получения ответов на ваши вопросы.
Если вы собираетесь много редактировать Вики, вам необходимо присоединиться к команде Ru_RU/Websites.