Подсветка программного кода в постах (для Wordpress)

Friday, 25 Jul 08 в 1:19

Вставка кода в текст блогаДостаточно часто возникает желание вставить в посте часть кода из какого-то языка программирования. Как оказалось, сделать это в Wordpress быстро и просто не получается, приходится немного потрудиться. Что я только не пробовал дабы вставки HTML, Javascript или хотя бы PHP выводились в блоге корректно - использовал и <code>, и <pre>, но, к сожалению, результаты были не утешительные. Возможно, конечно, кое где я ошибся сам, но, тем не менее, проблема вставки и разных исходных кодов была для меня актуальной достаточно долго. Недавно я заставил себя сесть и разобраться с ней раз и навсегда. Забегая наперед, скажу, что частично это мне удалось.

Проблема размещения в блоге исходного кода не самая серьезная, но иногда дает о себе знать. Особенно это касается различных постов, где вы описываете операции, относящиеся к программированию. Без примеров в таких случаях не обойтись, а движок Wordpress, как назло, вносит в код свои «правки». Текстовый редактор неоднозначно воспринимает символы одинарной и двойной кавычек, преобразуя их текстовые аналоги:

Wordpress иногда коверкает исходный код

При копировании такой «преобразованный» код работать не будет. Следовательно все посетители, которые захотят его применить, будут неприятно разочарованы.

Кстати, по старинке я вставлял код с помощью Macromedia Dreamweaver (теперь уже Adobe® Dreamweaver® CS3) , который позволял с легкостью получить из обычной записи тот же исходный код, но полностью в HTML (скобки < > заменялись на специальный символы). Увы, от проблемы с кавычками это не спасало. Поэтому пришлось искать альтернативные методы. В принципе, можно было бы сохранять исходники в текстовые файлы, после чего в статье на них ссылаться, но это, пожалуй, применимо лишь для больших объемов кода. Во всех остальных случаях - создавало бы лишние проблемы для посетителей.

Плагины wordpress для подсветки кода

Для решения проблемы я нашел 4 плагина, хотя их намного больше. Выбирал те, которые встречал у других блоггеров:

Raw HTML (скачать плагин)

Самый простой плагин. Позволяет вставлять HTML код в посты. Оборачивание текста в тэги <!–start_raw–>…<!–end_raw–> или [RАW]…[/RАW] предотвращает его преобразование. Во время вставки кода настоятельно рекомендуется выйти из визуального редактора в режим HTML. Поддерживает версию системы до 2.5.1.

CodeColorer (скачать плагин)

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

Вставка кода в wordpress с помощью плагина CodeColorer

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

SyntaxHighlighter Plus (скачать плагин)

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

Подсветка кода с помощью плагина SyntaxHighlighter Plus

Если присмотреться, то можно над кодом заметить дополнительные ссылки/функции view plain (просмотр кода в отдельном окне) copy to clipboard (копировать в буфер обмена) и print (печать). В блоге плагина есть небольшое описание, правда на английском. Хотя, в принципе, информации на официальном сайте wordpress вполне достаточно.

WP-Syntax (скачать плагин)

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

<pre lang=”LANGUAGE” line=”1″> … исходный код … </pre>

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

Выделение кода в wordpress в помощью плагина WP-Syntax

Вообще из всех четырех плагинов я не попробовал лишь CodeColorer, по остальным свое впечатление сложилось. Raw HTML слишком прост и не очень нагляден, SyntaxHighlighter Plus наоборот слегка «громоздкий», поэтому я выбрал золотую середину - WP-Syntax. Не исключено, конечно, что в дальнейшем установлю более продвинутый модуль, например, чтобы в комментариях код также подсвечивался. Только для начала нужно «прикрутить» в форму комментирования кнопки для форматирования или хотя бы добавить описание допустимых тэгов. В общем, работать еще есть над чем, а пока главное чтобы читатели могли видеть и использовать корректный код.

Кстати, при активном использовании Raw HTML и WP-Syntax заметил небольшую особенность. Как уже говорил выше, редактирование кода требуется производить при выключенном визуальном редакторе в режиме HTML, иначе при сохранении могут возникнуть глюки в виде исчезновения отдельных частей исходного кода. Все это оставило не очень приятный осадок после работы с плагинами, тем не менее, насколько я понимаю, от этого никак не избавиться. Поэтому будьте предельно внимательны!

Если у вас есть что добавить по теме, прошу высказываться в комментариях. Делимся опытом использования других плагинов, о которых я не упомянул.

P.S. Дмитрий Ветров предлагает обсудить вопрос должен ли блог быть авторским?

Кстати, если вы хотите раскрутить свой блог или проект, можете воспользоваться рекламными услугами в этом блоге - приобретаем спонсорство в месяц (около 15-ти публикаций) за $50 или постовые по $5 за ссылку. Также свободен баннер 125х125 под блоком контактов - всего $30.

Спасибо спонсорам:

Добавить комментарий

Комментариев - 20 для данного поста

  1. chipp.ru Пишет:

    Подсветка программного кода в постах (для Wordpress)…

    Достаточно часто возникает желание вставить в посте часть кода из какого-то языка программирования. Как оказалось, сделать это в Wordpress бы…

  2. dj_undead Пишет:

    Плагины возможно и решат данную задачу, но я например не люблю ставить на работающий сайт больше 4-5 активных плагинов одновременно. Поэтому пользуюсь замечательной разработкой от ЖЖ пользователей проектом SYHI(Syntax Highlighter for blogs) его адрес: http://syhi.stworks.ru/
    В данный момент система поддерживает синтаксис 28 языков. Примерно так:

    function addDefaults() {                if (!count($this->defArray)) return;                foreach ($this->defArray as $i => $pair) {                        $ret .= $this->DCName.".addIntoCollection(’{$pair[0]}:::{$pair[1]}’);\n";                }                return $ret;        }Syhi-подсветка кода

    Возможно единственный минус системы в том что она генерит большой объем HTML кода, но думаю это и с плагинами так.

    P.S.: Но плагинчики гляну, спасибо

  3. Tod Пишет:

    Ну это о том, что я говорил в качестве “старого метода”. По моему по наглядности оно не очень хорошо смотрится.

  4. @ Роман Настенко Пишет:

    Поздравляю c PR5, нас тут целый клуб 4-5 :)
    http://www.perfectomania.com/blog/2008/07/pagerank-update/

  5. @ mrkto Пишет:

    Насчёт корректных блоков pre, code написано: http://mrkto.com/php_and_wordpress_bugs/
    В текущей версии WP я уже свободно переключаюсь между визульн.ред./HTML без страха за код.

    Насчёт плагинов – мне не нравятся те, кот. с полосой прокрутки.

  6. Sergey Пишет:

    >> SyntaxHighlighter Plus
    Классная штука :) А то что html много, ну и ладно, 2-20 кб погоды не сделают :)

  7. Советы и хаки после установки wordpress 2.6 Пишет:

    [...] Подсветка программного кода в постах (для Wordpress) Фильтр мата Плагин - подсказка по выделенному [...]

  8. Киношник Пишет:

    Сам пользуюсь SyntaxHighlighter Plus - считаю его лучшим, что есть вообще.

  9. ТОП10 - Лучшее За Неделю #1(23.07-30.07) | iDotCom.ru Пишет:

    [...] проблемы по его внедрению в пост и подсветкой. Tod разобрался с этим раз и навсегда. Честно говоря, я не стал проводить проверку, но [...]

  10. Dimox Пишет:

    Я пользуюсь CodeColorer уже как минимум год. В принципе доволен им. И (хоть я и не автор), могу гарантировать, что он без проблем работает на WP 2.5+ :)

  11. Tod Пишет:

    У тебя-то я его и видел, когда делал обзор. Даже устанавливал, но что-то у меня с ним не все гладко получилось, поэтому я решил поискать еще плагинов. Возможно, просто ошибся где-то при изучении) бывает.

  12. Интересное для веб-мастеров (08.08.2008) » Пишет:

    [...] Подсветка программного кода в постах (для Wordpress) Достаточно часто возникает желание вставить в посте часть кода из какого-то языка программирования.

  13. VT Пишет:

    Спасибо за обзор. Как бы сделать кнопку в TinyMCE для вставки [sourcecode language=''][/sourcecode] ??

  14. Tod Пишет:

    VT, привет. Вот этого, к сожалению, не знаю.

  15. Подсветка программного кода в постах — За рублём Пишет:

    [...] Оригинал: Tod’s Blog [...]

  16. @ Yury_md Пишет:

    выглядит интереснее всех имхо, именно SyntaxHighlighter Plus, неужели такой громоздкий и неудобный?

  17. Tod Пишет:

    Yury_md, не то чтобы “очень”, просто мне не нужна была вся его функциональность, поэтому ограничился простым плагином.

  18. @ Yury_md Пишет:

    Tod, и приходится каждый раз при вставке кода писать эту конструкцию с языком кода?

  19. Tod Пишет:

    Yury_md, я вообще долго пост публикую, много чего правлю, в том числе и конструкцию для кода добавляю.

  20. Подсветка кода в Wordpress | CMS глазами пользователя Пишет:

    [...] который бы делал это без потери синтаксиса. Прочитал заметку Александра Тодосийчука по этому поводу. Не знаю, [...]

Оставить комментарий (правила комментирования)