From Fedora Project Wiki

Revision as of 12:14, 5 June 2008 by Anubis (talk | contribs)

Редактирование Wiki Fedora проекта

Wiki Fedora проекта имеет низкие барьеры для редакторов. Однако, необходимо небольшое обучение чтобы начать использовать wiki, и мы подчиняемся нескольким руководящим принципам, которым должны следовать все редакторы. Эта страница содержит эти принципы и несколько советов, которые помогут вам начать редактировать Wiki.

Получение доступа к редактированию.

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

Idea.png
Мы работаем над такими изменениями, чтобы подтверждение CLA (Contributor License Agreement (Лицензионное Соглаiение Участника)) происходило при создании начальной учетной записи одним кликом. Это позволит значительно сократить время и усилия для того чтобы перейти к редактированию Wiki. Мы ждем выпуска Moin 1.6, который обеспечит функции, которые можно использовать для подтверждения CLA одним кликом. Сроки выпуска пока не установлены.

1. Самостоятельно ознакомьтесь с информацией на этой странице и тех на которые она ссылается. Основные правила, которые следует соблюдать приведены здесь. Неспособность следовать этим принципам требует выполнения ненужной работы для других добровольцев и в результате может привести к отзыву привилегий редактирования.

1. Создание учетной записи. Первым шагом для получения прав редактирования является посещение страницы UserPreferences и создание учетной записи. Имя пользователя вашей учетной записи должно быть настоящим именем в формате WikiИмя (Например ИмяФамилия, IvanPetrov). Иногда их также называют 'CamelCase' или 'StudlyCaps'. Этот формат необходим для wiki ссылок.

Stop (medium size).png
Использование вашего настоящего имени в правильном формате очень важно!
Мы требуем настоящих имен для идентификации и отчетности по нескольким причинам. Использование правильного формата необходимо для обеспечения корректных wiki ссылок и для поддержи некоторых других возможностей которые мы используем.

1. Согласие с CLA (Лицензионное Соглашение Участника) через Систему учетных записей Fedora

Подписание CLA (Лицензионное Соглашение Участника) дает Проекту Fedora возможность лицензировать ваш вклад в wiki согласно Open Publication License 1.0 без оговорок. Это гарантирует что ваш вклад навсегда останется Свободным для общественного использования, изменения, и распространения, просто как Fedora distribution. См. ["Legal"] раздел для получения дополнительной информации. Следуйте инструкциям по подписанию CLA (Лицензионное Соглашение Участника) http://fedoraproject.org/wiki/Infrastructure/AccountSystem/CLAHowTo

1. Свяжитесь с кем-либо из Группы Редактирования EditGroup Все перечисленные в Группе Редактирования (EditGroup) могут добавить Вас в Группу Редактирования (EditGroup). Члены этой группы имеют доступ к редактированию большинства частей wiki. Если вы уже говорили с участниками, спросите их, смогут ли они добавить вас в группу редактирования. Лучше всего чтобы вы были уже знакомы к моменту получения доступа к редактирования, но это не обязательно. Если вы не можете ни с кем связаться, вы можете зайти на канал #fedora-websites на freenode . Если, по каким либо причинам это невозможно, добавьте себя сами на страницу EditGroupQueue и подождите пока кто-то из Группы Редактирования добавят вас.

Человек, который добавляет Вас, проверяет что вы находитесь в cla_done (согласившийся с CLA) группе с помощью through the Интерфейса запроса учетных записей .

Idea.png
Участие в Fedora Websites
Если вы заинтересованы в поддержке веб-сайта, или хотите влиться в Fedora веб-сайт команду, пожалуйста, см. страницу Websites.
Idea.png
Работа над Документированием Fedora
Информация по написанию официальных Fedora документаций используя wiki доступна на странице Написание Wiki Документаций.

Правила

Существует несколько правил которым вам необходимо следовать, как только вы изменили wiki. Ниже приводятся примеры. В общем, будьте вежливы и пользуйтесь здравым смыслом. Игнорирование этих правил создает проблемы и является дорогой к отмене доступа редактирования. Если у Вас возникли вопросы вы можете задать их на канале #fedora-websites на freenode .

Представьтесь

Прежде чем начать редактирование любой страницы, хорошо бы представиться, добавьте информацию о себе на своей wiki странице. После того как вы зарегистрировали ваше имя в wiki, для Вас автоматически создается персональная wiki страница расположенная по адресу http://fedoraproject.org/wiki/<WikiИмя>, где <WikiИмя> необходимо заменить вашим именем вашей учетной записи wiki.

Например, смотри CategoryHomepage.

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

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

Всегда подписывайтесь на страницы которые вы создаете или редактируете

Важно, чтобы вы следили за изменениями страниц, которые вы создали или редактировали, таким образом вы можете координировать другую работу по содержимому wiki. Wiki редакторы обычно добавляют заметки страниц для передачи информации каждому кто работает вместе, и это помогает отслеживать изменения.

Вы можете найти ссылку "Подписка" на боковой панели когда вы залогинились.

Будьте смелыми

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

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

Эти страницы писались основательно, а слова тщательно подбирались. Прежде чем изменять эти документы, обычно лучше посоветоваться. Вы можете обратиться в Консультативный Совет Fedora (Fedora Advisory Board) (см. Board страницу) за помощью.

Не публикуйте информацию запрещенного содержания

Не добавляйте информацию которая преследуется законом. Помните Проект Fedora находится в США и у подчиняется их закона. Избегайте того чтобы добавлять ссылки или дополнительную информацию о программном обеспечении которое не является свободным и открытым (free and open source) иначе это будет преследоваться по закону. Если вы считаете что вас случай исключительный, обсудите его с командой Websites . См. ForbiddenItems страницу примеров вопросов которых следует избегать.

Доведите до сведения команды Websites такие вопросы. Если необходимо, они дадут официальный ответ.

Будьте осторожными при редактировании ключевых руководств или страниц

Большие и важные руководства, такие как Packaging Guidelines(Руководящие принципы создания Пакетов) , в основном управляются конкретными людьми или маленькими группами. Лучше всего работать с ними когда вы чувствуете что необходимы изменения.

Важные страницы, такие как FedoraMain или Загрузка страницы, являются первыми страницами которые многие посетители видят. Изменение таких страниц нужно предоставить опытным . Если вы видите что-то на такоей странице что должно быть изменено, внесите свое предложение на обсуждение командой Websites.

Не редактируйте страницы просто чтобы редактировать

Следует избекать бессмысленных изменений. Внесение изменений в текст страницы только для того чтобы поместить свое имя в лог редактирования недопустимо. Есть много страниц (большинство, фактически) которые имеют реальные ошибки которые нужно исправить. Вместо того чтобы делать бессмысленные изменения, такие как добавление пробелов или изменение ссылок с fedoraproject.org на www.fedoraproject.org (первая предпочтительней, кстати), попробуйте найти ошибки в орфографии, грамматике или пунктуации которые можно исправить. Кроме того, при исправлении мелких ошибок помечайте редактирование как "Тривиальное редактирование" используя соответсвующий флажок прежде чем записать страницу.

Избегайте переименования страниц или перемещения содержимого без координации

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

Следуйте идеалам, которые Федора считает важными

Например, старайтесь сохранить рабочий стол нейтральным и удобным технически не подготовленных пользователей которые являются новичками в Линукс и Федора. Пользователи могут использовать GNOME, KDE, консоль, или какие либо другие среды. Старайтесь помнить об этом когда пишете инстракции. Будьте уверены в приверженности Федора принципам свободного и открытого обеспечения.

Подписывайте вложенные файлы

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

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

Изображения и простые документы безопасно оставлять без сигнатур, но если вы добавите их вреда не будет если кто то сможет удостоверится что вы автор этого документа.

Если у вас нет GPG ключа или вы хотите узнать больше об этом, см. страницу Cryptography.

Проверяйте ваши изменения на наличие ошибок

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

Федора - это сообщество

При написании документов для вики или где либо еще, помните что Федора является сообществом. "Мы" являемся единой группой движущейся к общим целям. "Мы" не отличаем одну группу или класс от другого. Например: нет необходимости проводить различия между добровольцами которые работают для Red Hat и теми кто не делает этого. Все добровольцы являются частю одного сообщества. Однако существуют случаи когда классификация необходима, но ее можно провести другим способом.

Если вы в чем то неуверены - просто спрашивайте.

Другие члены сообщества будут рады помоч вам. #fedora-websites кана на freenode идеальное место чтобы обсудить вики или другие веб сайты Федора.

Просматривайте Ваши страницы, а также страницы других участников

Две вещи позволяют Wiki быть успешным инструментом по совместному использованию открытого содержимого. Первая: возможность просмотреть содержимое за которое вы ответствнны для того чтобы убедиться что оно соответствует действительности. Second is being able to watch other content develop, grow, and occasionally need your help.

Чтобы наблюдать за страницей "подпишитесь" на нее

Направьте ваш RSS клиент чтобы извлекать из http://fedoraproject.org/wiki. необходимо подавать подходящий RSS файл. 1. Добавьте регулярное выражение для документа над которым вы работаете UserPreferences над Subscribed wiki pages. Например это выражение показывает 3 документа:

Docs/Drafts/AdministrationGuide.*
Docs/Draft/Glossary.*
Docs/Drafts/DesktopUserGuide.*

Это выражение наблюдает за всеми изменениями в данной области:

Docs/Drafts.*

Это выражение позволяет наблюдать за всеми изменениями на страницах DocsProject , включая Docs и Docs/Drafts  :

Docs.*

Редактируйте с помощью MoinMoin

Интерактивная помощь может быть ценным ресурсом при изучении как редактировать ВиКи страницы. Просматривая данные страницы помощи вы можете изучить некоторые новые аккуратные приемы. Вам необходимо ознакомиться с ними хотябы один раз и они всегда будут там в качестве краткой справки при редактировании страниц. Вы можете задать вопрос о редактировании на канале #fedora-websites о freenode.net .

Структура ВиКи страниц

Этот раздел описывает общую структуру Вики страницы. Придерживайтесь этих указаний для каждой Вики страницы. Существуют дополнтельные правила для официальной документации Федора, описанные в DocsProject/WritingUsingTheWiki ; эти правила необходимы только для писателей содержимого, чтобы следовать процедурам Fedora Documentation Project .

1. Заголовок страницы является заголовком первого уровня. Окружайте его с знаком разметки заголовка =:

= Заголовок страницы =

{{Message/note | Исключчения Страницы которые предполагается использовать всегда и только встроенными в другие страницы с помощью [[Inline()] -мактоса, эти страницы не начинайте с заголовка первого уровня. Структура этих не модульных подстраниц зависит от родительских и начинается с вложенного уровня родительского документа.}}

1. Над разделом = Заголовок страницы = и до == Введение == , включайте макрос создающий содержание страницы :

= Заголовок страницы  =



== Введение ==
Note.png
Исключения Нет необходимости включать содержание в страницы которые достаточно коротки, страницы которые можно прочитать без прокрутки в браузере открытом на 700 пикселей ввысоту.
Note.png
Исключение Целью включения содержания является удобство читателя. Если содержание мешает при чтении, удалите его.

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

]]

Idea.png
Используйте выпадоющее меню при сохранении изменений страницы
Простым способом сгруппировать страницы пункт меню Make this page belong to category который появляется на странице Wiki редактирования.
Note.png
Исключения Страницы в Docs/Beats являются source only и не включаются в категорию страниц CategoryDocs т.к. их не предполагают отображать как результат поиска документации. Если страница является источником содержимого но не является канонической или ссылкой следуя по которой можно найти эту информацию, тогда не включайте ее в категорию. Другим примером является любое содержимое под персональным NameSpace.

1. More to come

Советы

These are the basic things that you need to know to edit this Wiki.

Important.png
Pages Written for the DocsProject Have Additional Requirements
For more information on drafting documentation on the Wiki, refer to Writing Wiki Documentation .

Учитесь на примерах

Одним из самых лучших способов изучить способы редактирования wiki страниц является просмотр исходников существующих страниц. Это очень просто сделать:

  1. Найдите страницу исходники которой хотите просмотреть.
  2. На навигационной панели найдите combo box that reads 'More Actions:' и нажмите его.
  3. Выберите '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 | Это пример заметки. | Здесь содержится дополнительная информация о заметке.}}
Idea.png
Это заголовок обобщающий заметки.
Здесь содержится дополнительная информация о заметке.

Отступ в начального и второго параграфа на один пробел гарантирует что бокс будет правильно выровнен.

Ниже приведены стандартные виды замечаний:

  • Note.png Это иконка примечаний Note.png
  • Idea.png Это иконка заметок Idea.png
  • Warning.png Это иконка призывающая к осторожности Warning.png
  • Important.png Эта иконка о важном сообщении Important.png
  • Stop (medium size).png Это иконка о предупреждении Stop (medium size).png

См. Fedora Documentation Guide для описания типов замечаний:

http://fedora.redhat.com/participate/documentation-guide/s1-xml-admon.html

Выделение Технический Терминов

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

Используйте два 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 процессов.
Keystrokes [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.)

Заключите любой пример команды тройными фигурными скобками, на первой строке команды три открывающие фигурные скобки и три закрывающие фигурные скобки за командой:

#!html
<pre>
{{{su -c "yum install awesome-application"
}}}

Enter the <code>root</code> password when prompted.

Которое отображает:

su -c "yum install awesome-application"

Enter the root password when prompted.

Important.png
Пользовтели НЕ ДОЛЖНЫ работать как 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', а не 'FedoraWebsitesProject'.

В основном страницы должны быть сгруппированы по проектам или программам частью которых они являются. Категории должны создаваться для различных проектов и программ и должны создавать умеренно. Большинство страниц которые вы создаете должны быть частью категории и большинство из них должны иметь подходящий тэг. Если вы намереваетесь создать новую категорию или тэг, пожалуйста сперва посоветуйтесь с командой 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.

Получение справки

Если у вас есть вопросы по редактированию ВиКи Федора Проекта, или вам нужна помощь, просто обращайтесь к любому в команде Websites. Они имеют IRC канал и почтовую рассылку (mailing list), оба эти способа эффективны для получения ответов которые вам необходимы.

Если вы собираетесь много редактировать Вики, вам необходимо присоединиться к команде Websites.