Плагин для OctoberCms

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

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

На многих сайтах (во всяком случае в российском сегменте) добавлена возможность при выделении по ctrl+enter отправить администратору сайта сообщение об неточностях в тексте.Точно такой плагин я и собрался реализовать.

Структурно плагин состоит из 2 частей:

  • фронтенд - небольшой кусочек кода, который прикрепляется к публичным страницам и, при выделении по ctrl+enter, отправляет сообщение администратору
  • backend, список всех замеченных неточностей

Это упрощенная структура, которую еще можно улучшить. Например бэкенд может слать администратору письмо при появлении сообщения о ошибки.

Так как фронтенд не моя сильная сторона, то я предложил бывшему коллеге, написать плагин вместе со мной и отдать ему весть фронтенд.

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

За основу фронтенда был взят плагин и полностью переработан.

Из особенностей разработки:

  • Очень приятная система версионирования плагина. Сделано очень продумано и интуитивно понятно. К каждой версии прикладываете комментарий и, если нужно, то код который будет менять ваш плагин
  • Документация очень полная, но на мой взгляд не очень хорошо структурировано. Возможно это связано с недостатком знаний о системе в целом. Но я бы добавил больше поясняющей информации для начинающих разработчиков
  • Есть прекрасный и отзывчивый внутренний форум. На форуме невозможно найти ничего, собственно, как и почти на всех устоявшихся форумах. Зато есть живой чат, в котором можно посоветоваться с другими разработчиками
  • У октобер достаточно простые, но строгие правила по структуре кода. Как мне кажется страница с ними должна быть на самом видном месте. Я изначально писал код немного в другом стиле и был недоволен собой, когда пришлось переделывать часть кода. Пишите код сразу в нужном стиле
  • Для внутреннего общения само собой выбрался скайп. После slack читать переписки в скайпе об разработке очень-очень сложно. Выбирайте правильные месенджеры

Собсвенно сам плагин. Я выложил его во внутренний маркет и очень очень жду когда пройдет одобрение. Надеюсь, что он поможет сделать сайты на октобер лучше.

UPD: Плагин со второй попытки приняли. Администрация оказалась очень доброжелательной и помогла исправить некоторые ошибки в оформлении.

Posted in OctoberCms, Истории on Jun 24, 2015

comments powered by Disqus