С чего начать

Помочь MDC так же легко, как и использовать Ваш браузер. Если Вы когда-нибудь заполняли веб-формы, или использовали поле ввода текста для записей в блоги - значит Вы можете начать.

Введение

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

Основы

Это небольшое руководство по созданию и редактированию страниц в этой MDC-Вики. попробуйте ваши навыки в Песочнице.

Редактирование страниц

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

В правой колонке на каждой странице, вы увидите ссылку "Править". Нажав на ссылку, вы попадете на страницу с формой редактирования выбранной страницы, где вы cможете просмотреть, как будут выглядеть внесенные вами изменения, и сохранить их. Как только вы сохраните изменения, они сразу же отобразятся на странице.

Создание новой страницы

Простейший путь создать новую страницу - это создать ссылку на неё на вашей пользовательской странице, а затем перейти по этой ссылке чтобы "Править" её.

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

Создать ссылку на страницу, которую вы хотите создать, очень просто: напишите название страницы, обрамленной двойными квадратными кавычками, например: [[Образец|Это образец]]. После сохранения строка будет преобразована в ссылку, как эта: Это образец. Первая часть - до разделительной черты - название страницы, на которую указывает ссылка. Вторая часть - название самой ссылки, которую будет видеть пользователь.

Если страница ещё не существует, то ссылка будет красного цвета. Если она уже существует, то тогда ссылка будет синего цвета. Перед тем, как создать страницу, проверьте, не существует ли она уже.

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

Правила наименования страниц

Для подробностей смотрите страницу page naming guide.

Разметка Вики

Если вы сейчас нажмете на ссылку "Править" в колонке справа, то вы увидите что текст страницы разделен некоторыми специальными символами, например символы "==" вокруг заголовков, и скобки "[[ ]]" вокруг ссылок. Это очень простой вид разметки, уникальный для такой системы как Вики. Сильная сторона такой системы в простоте обучения, и лояльности к ошибкам пользователя

Ссылки на статьи о разметке Вики

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

Создание, редактирование, и проверка

немного более длинное введение в MDC для авторов, редакторов, и рецензентов.

Авторы

MDC заинтересован в новом содержании, и мы поощряем написание новых статей на любые темы которые сейчас существуют в Вики. Они могут быть как простыми - в виде простого совета, или более сложные, как книга или руководство по программированию. Количество статей не ограничено.

Ошибки, занесенные в базу данных Багзилла, которые влияют на документацию, должны отмечаться ключевым словом dev-doc-needed. Это один из лучших способов найти вещи, которые нуждаются в документировании (описании). Как правило, только ошибки, для которых изменения были уже внесены в исходники, должны быть описаны. Когда необходимые изменения внесены в документацию, ошибка должны быть помечена ключевым словом dev-doc-complete.

Если вы собираетесь заняться большим проектом, предлагаем вам присоединиться к MDC сообществу и обсудить - может быть кто-то еще собирается начать (или уже начал) подобный проект.

Обращайтесь к нашему Руководству авторам если у вас возникнут вопросы по стилю или политике использования (?) Вики.

Редакторы

Мы всегда приветствуем редакторов в нашей Вики чтобы исправить или улучшить стиль, исправить грамматические, синтаксические и прочие ошибки. Пожалуйста, обращайтесь к нашему Руководству для авторов для подробностей.

Корректоры

Технические правки и замечания также приветствуются. Если вы читаете страницу, и обнаружили техническую ошибку (будь то код или текст), вы можете без лишних трудностей исправить её. Если это неоднозначное (спорное) изменение, оставьте своё замечание в "Обсуждении" этой страницы (ссылка "Обсуждение" в колонке справа), в котором опишите причину, по которой вы сделали изменение.

Руководство авторам

Существует Руководство авторам, описывающее предпочтительный стиль ведения записей в Вики. Если у вас есть вопросы по использованию и стилям, которые не описаны там, рекомендую обратиться к Economist style guide (Eng.), или в случае неуспеха, к Chicago Manual of Style (Eng.).

Руководство постоянно пополняется, так что если у вас есть необычные вопросы, которые не поясняются в Руководстве авторам, пожалуйста, присылайте их нам в список рассылки MDC или руководителю разработчиков документации.

Перенос старой документации

Один из длительных подпроектов в MDC - это перенос всей существующей документации разработчиков с сайта mozilla.org в систему Вики MDC. Эта процедура очень проста:

  1. Взять документ, который вы хотите перенести из списка текущего содержания.
  2. Обратиться к руководству наименования страниц и решить - какая страница или страницы должны соответствовать в Вики
  3. Создать эти страницы и перенести содержимое, разметив наилучшим способом, пользуясь руководством разметки Вики
  4. Удлите перемещенный документ из списка текущего содержания.
  5. Запишите его в список нуждающихся в перенаправлении.

Если вы хотите полностью выполнить работу над переносом, вам необходимо будет сделать следующее:

  1. Используя нашу поисковую систему найти все ссылки на исходный документ в Вики, а затем заменитьих ссылкой на созданную вами страницу в Вики.
  2. Проверить наличие во внешних ссылках исходного документа, и пометить ссылки к удалению, поместив их в категорию "Junk", добавив [[Category:Junk]].

Перевод MDC

Если вы хотите помочь перевести документацию в MDC Вики на какой-нибудь другой язык, просто посетите Вики на соответствующем языке и создавайте или редактируйте страницы

Существующие проекты переводов

Сейчас в MDC есть Вики для следующих языков: Català, 中文(简体), Deutsch, English, Français, Italiano, 日本語, Nederlands, Polski, Português, Español, 한국어, 中文(正體), Русский.

Как начать проект перевода на новый язык

Если вы хотите начатьновый проект перевода на язык, которого еще не существует в Вики, пожалуйста, прочтите раздел Проекты переводов и следуйте инструкции.

Решение "войны редакторов" или иных конфликтов

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

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

Запрос на удаление страниц

Если вы создали страницу случайно, или наткнулись на страницу, которая, как вы считает, должна быть удалена, добавьте её в категорию "Junk" ("Мусор"), добавив [[Category:Junk]] в заголовок страницы.

Категория "Мусор" периодически проверяется администраторами Вики, и страницы, которые к ней относятся, оцениваются и если требуется, удаляются.

Примечание: Пожалуйста, не удаляйте прочее содержимое страницы, которую вы пометили как "Мусор"

Присоединиться к MDC сообществу

Центр Разработки Мозилла (MDC) в значительной степени ручная работа группы добровольцев, и мы всегда рады помочь новым авторам и редакторам влиться в проект.

Список рассылки / новостная группа

  • View MDC forums...

IRC канал

Мы также располагаемся на сервере irc.mozilla.org на канале #devmo: #devmo on irc.mozilla.org.

Руководитель проекта

За MDC и разработкой документации присматривает Eric Shepherd.

Document Tags and Contributors

Contributors to this page: Cobalt747, chargik, Denai, fscholz
Last updated by: chargik,