Markdown Comment Block: плагин, позволяющий добавлять заметки для редакторов в WordPress

Рич Табор, работающий сейчас в GoDaddy, в конце прошлой недели написал твит о том, что у него появилась идея для нового блока. Вскоре после этого на сайте WordPress.org появился новый плагин Markdown Comment Block.

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

Блог Миши Рудрастых

Плагин позволяет создать новый блок, который работает практически так же, как и обычный блок Paragraph:

Пользователи могут менять цвет текста, однако у них не будет доступа к инструментам управления Rich Text. В целом они здесь и не нужны.

Как мы можем видеть, комментарии задаются с помощью двойного процента. Технически в спецификации Markdown для комментариев не заданы никакие специальные символы. Спецификация позволяет обрабатывать обычные HTML-комментарии. Но у них имеются свои минусы – такие комментарии появляются во фронтэнде при обработке документа. Обозначение комментариев через %% попадалось мне в приложении Inspire Writer для Windows. Рич сказал, что видел то же самое в Ulysses. Этот функционал также существует в редакторе Iceberg для WordPress, который Рич разработал совместно с Джеффри Карандангом.

Плагин также добавляет клавиатурный шорткат %%. Если ввести эти символы в редакторе, на месте курсора появится блок Markdown Comment.

Я лично решил, что буду с его помощью оставлять для себя заметки. Также плагин может быть полезен для редакторов. Блок добавляет кнопку Resolve в тулбар. Щелчок по ней позволяет удалить комментарий.

Сам по себе блок вряд ли станет находкой для сложных рабочих процессов – у него слишком ограниченный функционал. Однако в объединении с плагином Post Descriptions он способен существенно улучшить опыт взаимодействия для крупных команд копирайтеров и редакторов.

Плагин Post Descriptions дает возможность пользователям публиковать заметки на уровне записей. Эти заметки появляются на экране управления записями. Благодаря им другие участники команды смогут узнать, когда можно проверять статью. Однако не всегда понятно, какие проблемы осталось решить перед публикацией. Блок Markdown Comment добавляет встроенную систему комментариев, позволяющую членам команды обмениваться текстовыми заметками.

Блок использует настраиваемые свойства CSS, что упрощает перезапись стилевых правил.  В считанные секунды мне удалось привести блок в соответствие с моей темой:

Переменные –markdown-comment-font-size, –markdown-comment-line-height и –markdown-comment-color доступны для разработчиков тем.

Единственное, что мне не понравилось – заголовок блока «Comment». Его легко спутать с шестью другими блоками для комментирования, которые уже имеются в списке блоков WordPress. В будущем этих блоков станет еще больше. Потому лучше его как-то переименовать. К примеру, назвать его «Markdown Comment», что выделило бы его среди других решений.

Поделиться с друзьями:
Добавить комментарий

Получать новые комментарии по электронной почте.