Редактор вики-текста 2017

This page is a translated version of the page 2017 wikitext editor and the translation is 99% complete.

Редактор вики-текста 2017 — это режим в расширении VisualEditor, позволяющий редакторам использовать инструменты и интерфейс визуального редактора для редактирования вики-текста. Этот режим можно включить внутри визуального редактора при помощи кнопки в панели инструментов.

Редактор викитекста 2017 года был выпущен для вики, размещенных Фондом Викимедиа, в 2023 году. Этот редактор не используется по умолчанию. Вы можете согласиться использовать его на вики-сайтах Викимедии, перейдя в ваши настройки, установив флажок "Использовать режим вики-кода в визуальном редакторе вместо отдельного редактора вики-кода", а затем нажав "Сохранить".

Что это такое

С целью исполнения одной из задач из 2016-2017 годового плана, «Поддерживать и последовательно улучшать средства создания и изменения информации», команда Викимедиа, ответственная за инструменты редактирования, работает над новым редактором вики-текста.

Он интегрирован в визуальный редактор, что упрощает переключение между двумя режимами. У него схожий дизайн и большинство инструментов, которые уже есть в визуальном редакторе, в том числе служба citoid. Новый режим редактирования вики-текста доступен для пользователей настольных компьютеров. Главная задача в Фабрикаторе — это задача T104479 (там это ПО иногда называют "современный редактор вики-текста" ("modern wikitext editor") или «новый редактор вики-текста» ("new wikitext editor"/"NWE")).

Это новый редактор, а не модификация уже существующего редактора. Поскольку редактор основан на VE surface, а не на стандартной текстовой области, многие гаджеты редактирования с ним не работают (для доступа к викикоду требуется использование очень специфического API). Gadgets that open an edit form and require a textarea can switch to plain wikicode editor using action=submit (rather than action=edit).

Причины реализации этого проекта

В 2010 году Фонд Викимедиа завершил проект по юзабилити (который дал нам нынешний скин Тема оформления:Векторное , инструмент выгрузки и 2010 wikitext editor ) и переключился на вопросы, выбранные сообществом в Стратегии на 2010-2015 годы. Это включает в себя ряд улучшений для инструментов редактирования, прежде всего визуального редактора, а также уведомления и другие улучшения. Но следует отметить, что в стратегии Викимедиа замена вики-текста не рассматривается и никогда не рассматривалась; мы считаем, что обе эти системы редактирования важны в долгосрочной перспективе, чтобы сообщество могло продолжать делать проекты Викимедиа всё более успешными.

По состоянию на декабрь 2016 года, почти на всех вики Викимедиа предоставляются три основных редактора страниц. С точки зрения пользователей эти редакторы сильно отличаются друг от друга внешним видом, работой, производительностью, а также справкой и технической поддержкой. Один из этих редакторов — разработанный в 2010-х для настольных компьютеров редактор вики-текста, называемый WikiEditor. Другой — визуальный редактор в своих разновидностях для настольных ПК и мобильных устройств. Наконец, третий редактор — крайне минималистичный редактор вики-текста для мобильных устройств.

Во время, прошедшее с 2010 года, мы узнали очень многое о том, как участники вики, будь они новичками или опытными редакторами, используют наше программное обеспечение, и о том, как бы они хотели его использовать. Наши исследовательские данные были использованы при создании визуального редактора в таком виде, в котором он работает приемлемо для всех редакторов: он отчётливо показывает новичкам, как его использовать, и в то же время не надоедает опытным участникам, которым нужно выполнить известное им действие за минимально возможное время. Мы обнаружили, что несмотря на несовершенства визуального редактора, новички отдают сильное предпочтение ему за дизайн, подсказки по работе, и общее качество взаимодействия. Также мы решили большое количество инженерных задач, чтобы визуальный редактор мог использоваться на странице (при нажатии на кнопку «Править код»), в инструменте (Flow), причём как и на настольных ПК, так и на мобильных устройствах, к тому же ещё и с возможностью расширения функциональности другим ПО.

То, что у нас есть три совершенно разные системы редактирования, плохо. Это плохо для начинающих редакторов, потому что те навыки, которые они усвоили, используя один редактор, оказываются неприменимы в других случаях (например при редактировании страниц обсуждения). Это плохо для уже более-менее опытных редакторов, которым нужно ответить на ряд вопросов со столкнувшимся с проблемой новичком, чтобы выяснить, что этот новичок хочет сделать и как ему помочь. Для администраторов это тоже плохо, так как им приходится настраивать ПО под нужды сообщества раздельно для каждого редактора — и при этом они могут обнаружить, что желаемая возможность в некоторых редакторах нереализуема. Это плохо для разработчиков сценариев и гаджетов, которым приходится поддерживать большее количество различных ситуаций (или игнорировать некоторые из них, делая свой продукт неработоспособным в этих случаях). Это плохо для разработчиков, которым приходится учитывать в три раза больше компонентов при любом исправлении ошибки или добавлении новой функциональности. Наконец, это плохо для людей, пожертвовавших свои деньги Фонду Викимедиа: их пожертвования тратятся на поддержку этих множественных параллельных направлений деятельности.

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

Пользователи, которым это не нравится, могут отключить его. Текущий редактор вики-текста никуда не исчезнет, по крайней мере, в следующие несколько лет. Хотя в конечном итоге мы можем закатить все, кому он нравится, могут оставить его себе.

Этапы разработки и текущее состояние

Первый релиз (бета-версия)

Изначальными целями проекта было обеспечение равенства по функциональностью с существующим редактором вики-текста WikiEditor, используя ту же панель инструментов с теми же кнопками в тех же местах, что и у визуального редактора, чтобы опыт пользователей был сходным. Это означает предоставление как минимум всех этих элементов управления в редакторе вики-текста, за очень немногочисленными исключениями в виде наиболее редко используемых кнопок:

  • Базовые инструменты (выделение полужирным, выделение курсивом, подпись, создание ссылок, вставка изображений);
  • Инструменты для продвинутых пользователей (заголовки, маркированные списки, нумерованные списки, больший шрифт, меньший шрифт, надстрочный и подстрочный текст, галереи и таблицы);
  • Вставка спецсимволов; и
  • Поиск и замена.

К августу 2016 все вышеперечисленные инструменты были реализованы, в дополнение к ряду инструментов, не присутствовавших в существовавшем редакторе вики-текста (таких как вычёркивание, подчёркивание и вставка шаблонов), а также функциональность наподобие автоматического преобразования HTML в вики-текст. В особенности следует отметить инструмент «citoid», предоставленный для автоматической вставки ссылок на источники (URL или DOI). Этот инструмент похож на гаджеты, которые некоторые вики, например английская Википедия, писали для внутреннего пользования, но превосходит эти гаджеты по возможностям и доступен на всех вики.

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

Финальный бета-релиз (перед основным релизом)

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

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

К возможностям второй категории (задачи, требующие отзывов пользователей) относится предоставление доступной в редакторе справки, с первого нажатия кнопки «Править» направляющей действия пользователей в ходе всего процесса редактирования; справка должна будет помогать и более опытным редакторам. На данный момент в редакторе вики-текста есть вкладка «Справка», содержащая поверхностное описание возможностей вики-текста; в визуальном редакторе у нас есть ссылка на руководство пользователя, и мы бы могли продублировать это руководство для этой задачи. Вопросы по функционированию и содержанию руководства по редактору вики-текста будут согласованы с нашими редакторскими сообществами, и мы считаем, что получим немало стоящих идей от опытных участников вики-проектов. Нам также нужно будет привести в порядок способы взаимодействия гаджетов с редактором, так как текущий механизм интеграции редактора чрезмерно сложен и может сбить с толку. Из-за этих проблем перевод гаджетов на работу с новым редактором сложнее, чем следовало бы. Большое количество вики-сообществ используют такого рода гаджеты для ускорения редактирования, и для нас важно оставить у вики-сайтов возможность гибко экспериментировать с такого рода усовершенствованиями.

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

Желательные функции

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

Подсветка синтаксиса вики-текста — значительное и часто обсуждаемое нововведение, способствующее направлению взгляда редакторов на нужный им фрагмент кода. Эта функциональность была реализована ещё в 2011 году для существовавшего тогда редактора вики-текста, но её введение пришлось отменить, так как высокая сложность вики-текста приводила к тому, что для большинства пользователей код подсветки синтаксиса выполнялся слишком медленно. Прошло пять лет, и компьютеры большинства редакторов стали несколько быстрее, чем они были тогда. Также нам следовало бы изучить, насколько мы можем повысить производительность подсветки синтаксиса путём упрощения алгоритмов выбора подсвечиваемых элементов вики-текста.

(А пока подсветка синтаксиса реализована в сценарии участника Remember the dot и WikEd , которые доступны на некоторых вики как гаджеты.) Использующая расширение Расширение:CodeMirror подсветка синтаксиса введена в редактор вики-текста 2017 года (gerrit:343878).

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

Мы могли бы предоставить ещё одну функцию редактора, а именно показывать редакторам, когда они сохраняют правку, две-три кнопки, добавляющие описание правки одним щелчком мыши; вставляемые описания подбираются в зависимости от недавних действий этого редактора. Эта функциональность довольно популярна на некоторых вики, где она реализована как гаджет, и было бы неплохо дать воспользоваться ей всем участникам на всех вики, включая те вики, где нет специалистов по гаджетам, способных настроить имеющийся гаджет и поддерживать его в рабочем состоянии.

Ресурсы


См. также