Как создавать и редактировать страницы

Данная статья предоставляет новым контрибьюторам основную информацию о процессе создания и редактирования страниц.

Редактирование уже существующей страницы

Чтобы редактировать страницу:

  1. Кликните на кнопку Редактировать в правом верхнем углу страницы.
  2. Затем страница перезагрузится, и вы увидите редактор, в котором можно добавлять или удалять информацию напрямую.
  3. Добавляйте параграфы, удаляйте текст, вставляйте заголовки и используйте другие основные функции, которые нужны для написания и редактирования.

Смотрите руководства Редактор UI элементов в Руководстве по MDN редактору, чтобы получить больше информации об использовании встроенных MDN редакторах.

Предварительный просмотр изменений

Чтобы посмотреть, как ваши изменения будут выглядеть:

  • Кликните на кнопку Предварительный просмотр в режиме редактирования, в в самом верху или низу страницы.
  • Это откроет страницу предварительного просмотра, показывающую ваши изменения (ревизии) в новом окне или вкладке.
  • Каждый раз, когда вы нажимаете на кнопку Предварительный просмотр, ваша страница предварительного просмотра обновляется до последних изменений.

Будьте аккуратны! Предварительный просмотр не сохраняет ваши изменения. Не закрывайте вкладку с редактором, пока не сохраните свою работу.

Комментарий к ревизии

После предварительного просмотра своих изменений вы захотите сохранить свою ревизию. Перед тем, как сохранить, посмотрите на текстовый блок с комментарием к ревизии, находящийся внизу страницы и оставляющий комментарий для того, чтобы объяснить другим контрибьторам, зачем вы сделали изменения. Например, вы могли добавить новую секцию, изменить текст, чтобы сделать терминологию более упорядоченной, переписать параграф для лучшего объяснения или удалить определённую информацию, так как она просто лишняя.

Содержание

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

Метки статьи (теги)

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

Требуется проверка?

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

Прикрепить файлы

Если вы хотите прикрепить файлы к существующей странице или добавить иллюстрацию для объяснения, это может быть сделано внизу страницы. При загрузке изображения, пожалуйста, убедитесь, что используете инструменты оптимизации, чтобы сделать файл маленьким, а загрузку возможной. Это улучшает время загрузки страницы и помогает производительности MDN в целом. Вы можете использовать свой любимый инструмент, если он у вас есть. Иначе, мы предлагаем TinyPNG - удобный Веб инструмент.

Публикация, отмена или дальнейшие изменения

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

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

Нажатие клавиши Enter в поле ввода комментария к ревизии то же самое, что нажатие кнопку Сохранить и продолжить редактирование.

Примечание: Если при попытке сохранить изменения, они были не приняты как некорректные, но вы считаете, что правки полностью приемлемы для MDN, обратитесь к администрации MDN за помощью.

Получение прав на создание страниц

По причинам безопасности недавно созданные аккаунты не имеют права добавлять новые страницы. Если вы попытаетесь сделать это, то увидите страницу с инструкцией, как создать страницу. Есть два варианта:

  • Попросить, чтобы страница была создана для вас. Чтобы сделать это, отправьте запрос с темой "Create page: <название страницы>". Заполните адресную строку URL, указывающим, где именно на MDN вы хотите видеть страницу. В поле ввода комментария укажите, почему вы хотите создать эту страницу.
  • Запросить права на создание страниц. Если вы оставите заявку на получение прав и получите их, то вы сможете добавлять новые страницы в соответствии с инструкциями, приведёнными здесь. Чтобы оставить заявку, свяжитесь с администрацией MDN. Напишите своё имя пользователя (username) и почему вы хотите создавать страницы. Например, вы делаете документацию для нового API, которая требует добавления новых страниц, или вы хотите добавить новые термины в глоссарий. Также вы должны сделать полезные изменения содержимого для этой страницы и быть контрибьютором ещё некоторое время. Время и другие вещи рассматриваются вместе.

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

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

Если вы не знаете, где разместить новую статью, не беспокойтесь. Вставьте её, куда угодно: мы найдём её и переместим туда, где ей лучше всего быть, или используем её в уже существующем контенте. Также не волнуйтесь о том, чтобы статья выглядела идеально. У нас есть гномы-помощники, которые помогают сделать вашу статью понятнее и привлекательнее.

Есть несколько способов создать страницу:

Ссылка на отсутствующую страницу

Как и в большинстве вики, возможно такое, что есть ссылка, ведущая на страницу, которой ещё нет. Например, автор мог написать список участников API перед тем, как создать страницы для этих участников. На MDN ссылки на несуществующие страницы обычно отображаются красным цветом.

Чтобы создать отсутствующую страницу:

  1. Войдите в MDN аккаунт с правами на создание страниц. Если вы не зайдёте, тогда при переходе на ссылку на отсутствующую страницу будет выводиться ошибка 404 (страница не найдена).
  2. Кликните на ссылку на отсутствующую страницу. Если у вас есть соответствующие права, тогда перед вами откроется MDN Редактор (Editor) UI для создания страницы.
  3. Напишите содержание страницы и сохраните её.

Новая страница без ссылки

Чтобы создать новую страницу без ссылки с другой страницы, введите имя несуществующей страницы в адресной строке вашего браузера. Например, если вы введёте:

https://developer.mozilla.org/ru/docs/FooBar

MDN создаст новую страницу с заголовком "FooBar" и открытым редактором для добавления контента. Вернитесь к разделу Редактирование уже существующей страницы в этой статье, чтобы узнать, как работать в редакторе.

Чтобы создать новую страницу без ссылки с другой страницы:

  1. Войдите в аккаунт с правами на создание страниц.
  2. Введите следующий текст в адресную строку своего браузера:
https://developer.mozilla.org/ru/docs/new

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

Подстраница уже имеющейся страницы

Чтобы создать подстраницу:

  1. На "родительской" странице (parent page) нажмите кнопку Дополнительно (значок шестерёнки в правом верхнем углу страницы) и выберите Новая подстатья.
  2. Откроется редактор для создания документа.
  3. Добавьте заголовок в поле Заголовок.
  4. Если нужно, измените Slug поле. Например, если заголовок длинный и короткий URL смотрится лучше. Это поле по умолчанию заполняет редактор, заменяя в заголовке пробелы нижними подчёркиваниями и изменяя только последнюю часть URL.
  5. В поле Оглавление выберите уровни заголовков, которые нужно отобразить. Если же оглавление не нужно, можно выбрать "Нет содержимого".
  6. Напишите статью в редакторе и сохраните изменения. Вернитесь к разделу Редактирование уже существующей страницы в этой статье, чтобы узнать больше о редакторе.

Клонирование уже имеющейся страницы

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

  1. На оригинальной странице нажмите на кнопку Дополнительно и выберите Клонировать эту статью. Откроется редактор для создания нового документа.
  2. Измените Заголовок страницы в соответствии с контентом. Поле Slug обновится автоматически, как только вы измените Заголовок.
  3. Измените путь в поле Slug, если нужно вставить документ в другое место в иерархии документа. В большинстве случаев это не нужно. Клонированная страница чаще всего схожа по контенту с оригиналом, поэтому желательно, чтобы она была в том же месте.
  4. В поле Оглавление выберите уровни заголовков для содержания. Или выберите "Нет содержимого", если это не нужно.
  5. Напишите статью и сохраните изменения. Вернитесь к разделу Редактирование уже существующей страницы в этой статье, чтобы узнать больше о редакторе.

Ссылка из уже имеющейся страницы

Это в какой-то степени гибрид. Вы можете создать ссылку на другую страницу, затем нажать на ссылку, которую вы только что создали, чтобы добавить новую страницу:

  1. Введите имя новой страницы, где угодно, чтобы это был текст на существующей странице.
  2. Выделите это новое имя и нажмите на значок ссылки () в панеле инструментов редактора. Окно "Обновить ссылку" откроется с выделенным текстом в поле "Ссылка на".
  3. "/ru/docs/" вставлена по умолчанию в начале URL. Введите имя страницы после "/ru/docs/". Название страницы необязательно должно совпадать с текстом ссылки.
  4. Нажмите OK, чтобы создать и вставить ссылку.

Если страницы ещё не существует, то ссылка будет красного цвета. Если же страница уже есть, то ссылка будет синего цвета. Если вы хотите создать новую страницу, но заголовок уже занят, проверьте, возможно вы можете помочь редактировать и улучшить эту страницу. С другой стороны придумайте уникальное имя для своей страницы и сделайте ссылку для неё. Посмотрите также Руководство по оформлению материалов MDN.

Обновление содержимого страницы

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

  • Чтобы вручную обновить страницу перезагрузите свой браузер. MDN заметит эту перестройку страницы и обновит выходные данные макроса и интегрированный контент на странице.
  • Вы также можете настроить страницы на автоматическое периодическое обновление. Это не стоит делать, если вы собираетесь обновлять страницу часто. Смотрите Регенерация страниц для более детальной информации.

Смотрите также