Плагин TopicIntro - работаем с анонсами

После статьи Плагин TopicIntro — автопревью к статье, анонс статьи и прочие «плюшки» я так и так собирался написать более подробно, как максимально эффективно использовать все возможности этого плагина, но планировал сначала написать про превью-изображения, а потом уже про интротекст (или анонсы). Но, видимо, работа с анонсами вызывает больше вопросов, поэтому сейчас я расскажу именно об этом. В этой статье, говоря о настройках, я буду иметь ввиду настройки в конфиг-файле плагина. Напомню, что менять лучше всего не оригинальный конфиг-файл, который находится в папке /common/plugins/topicintro/config/config.php, а его копию, которую нужно поместить в папку /app/plugins/topicintro/config/.

Создание интротекста

Для начала, чтобы плагин начал работать с интро-текстом, нужно включить эту возможность в конфигурации:

$config['introtext']['enable'] = true;

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

{$oTopic->getIntroText();}

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

$config['introtext']['autocreate'] = true;

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

$oTopic->getIntroText('>>>'); // вместо многоточия будет три символа >>>
$oTopic->getIntroText('');    // после обрезаемого текста не будет ничего дополнительно выводится

Интротекст и краткий текст топика

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

$config['introtext']['text_short'] = true;

С этой настройкой в том случае, когда запрашивается короткий текст топика (это текст перед тегом <cut>, который возвращается методом getTextShort()), а его нет, то будет возвращаться интротекст (который, как описано выше, может создаваться автоматически).

Короче, если на сайте много текста, который вы хотите принудительно убирать под кат, то:

$config['introtext']['enable'] = true;     // включаем использование интротекста
$config['introtext']['max_size'] = 200;    // длина интротекста
$config['introtext']['autocreate'] = true; // включаем автосоздание интротекста
$config['introtext']['text_short'] = true; // использование интротекста, если нет короткого текста

И все, ваша проблема решена.

Автоматический вывод интротекста

В заключение еще пара настроек в конфиг-файле, которые позволяют автоматически выводить интротекст на страницах сайта:

$config['introtext']['hook_list'] = 'template_topic_content_begin';

Здесь указан шаблонный хук, по которому будет выводиться интротекст. Это значит, что если в шаблоне есть такая строка:

{hook run='topic_content_begin' topic=$oTopic bTopicList=true}

то в это месте будет выведен интротекст топика. Как именно он будет выводиться, задается в шаблоне плагина field.intro_text-list.tpl. Хотите, чтобы интротекст выводился как-то иначе? Создайте папку /common/plugins/topicintro/templates/skin/<ваш_скин>/tpl/fields/ скопируйте туда файл field.intro_text-list.tpl и внесите туда нужные исправления.

Если не хотите, чтобы интротекст выводился автоматически, то просто закомментируйте в конфиг-файле строку с хуком, добавив двойной слеш в начале строки, вот так:

//$config['introtext']['hook_list'] = 'template_topic_content_begin';

Все то же самое касается и хука для вывода интротекста при просмотре топика (параметр $config['introtext']['hook_show']).