TextKit — Программа для быстрой подготовки контента и публикации в CMS 

 

Использование макросов

TextKit позволяет использовать макросы для некоторых инструментов.

На данный момент, макросы используются в следующих средствах:

  • Формирование предположительного ЧПУ.
  • Замена текста.
  • Специальная вставка (вставка картинок), ручная вставка картинок.
  • Автокомментарии.
  • Вставка кода, вводных фраз/эпилогов.
  • Настраиваемый экспорт.

Макрокоманда представляет собой выражение, заключенное между двумя символами процентов (%), поэтому для избежания возможных конфликтов нужно быть внимательнее при использовании этого символа. Некоторые макросы могут принимать параметры, перечисляемые через «:» (двоеточие), в большинстве случаев параметры не обязательны и могут опускаться. Чтобы передать двоеточие в составе параметра поставьте перед ним «\» (обратную косую черту).

Список макросов и их значение

  • %title:filter% — заголовок записи/рубрики. Параметры: filter — фильтр вывода (см. далее)
  • %name% — ярлык (slug) записи/рубрики
  • %description:filter% — краткое описание записи/рубрики. Параметры: filter — фильтр вывода
  • %parent_title:filter% — заголовок родительского элемента (рубрики, страницы, записи)
  • %parent_name:'all'% — ярлык родительского элемента (рубрики, страницы, записи). Параметры: all — необязательное (по умолчанию отключено), если установлено, выводит путь (rootpage/subpage/page) до верхнего родительского элемента, используется для получения ЧПУ
  • %post_content:filter% — текст записи
  • %post_tags:sep:count:'rand':filter% — метки записи. Параметры: sep — разделитель (запятая по умолчанию), count — количество (по умолчанию все), 'rand' — если установлено, вывод в случайном порядке, filter — фильтр вывода, применяется к каждой метке отдельно
  • %post_xcats:sep:count:'rand'% — дополнительные рубрики записи, через запятую. Параметры те же, что и для %post_tags%
  • %post_keywords:sep:count:'rand'% — ключевые слова записи, через запятую. Параметры те же, что и для %post_tags%
  • %post_date:format:filter% — дата публикации записи. Параметры: format — формат вывода времени, см. ниже (по умолчанию используется краткая форма записи в соответствии с настройками вашей ОС), format — фильтр вывода

Макросы, не привязанные к определенной записи

  • %date:format:filter% — текущая дата. Параметры те же, что и для %post_date%
  • %counter:start:step:'local'% — Счетчик. Параметры start — начальное значение счетчика (по умолчанию 1), step — шаг (по умолчанию 1), 'local' — если установлено, сбрасывает счетчик на первоначальное значение для каждой записи (по умолчанию не установлено).

Внимание!

Не рекомендуется использовать макросы %post_title% и %post_content% в операциях над заголовками и текстом записей соответственно.

Дополнительные макросы для настраиваемого экспорта

  • %url% — адрес ссылки на запись/рубрику
  • %parent_url% — адрес ссылки на родительскую запись/рубрику
  • %next_url% — адрес ссылки на следующую запись/рубрику
  • %previous_url% — адрес ссылки на предыдущую запись/рубрику

Фильтры вывода

Определенным образом преобразуют последовательность символов, возвращаемых макросом.

  • htmlencode — кодирует зарезервированные символы HTML в сущности. Например &, <, > в &amp;, &lt;, &gt; соотв.
  • htmldecode — действует обратно htmlencode
  • urlencode — подготавливает результат макроса к использованию в качестве части URL'а. Например, заменяет пробел на «+»
  • urldecode — действует обратно urlencode
  • translit — преобразует кириллические буквы в созвучные им латинские. Например, «медвед» в «medved»
  • nicename — сперва преобразует в транслит, а потом заменяет все не буквенно-цифровые символы на дефисы. Полученная строка может использоваться в URL. Например, «Превед, медвед!» в «preved-medved»

Примечание:

Фильтры можно комбинировать через | (вертикальная черта), например, translit|htmlencode сначала применит translit, затем htmlencode

Краткий справочник форматов даты и времени

  • d — представляет день месяца в виде числа от 1 до 31.
  • dd — представляет день месяца в виде числа от 01 до 31.
  • ddd — представляет сокращенное название дня недели (согласно настройкам ОС).
  • dddd — представляет полное название дня недели (согласно настройкам ОС).
  • h — представляет часы числом от 1 до 12, то есть в 12-часовом виде.
  • hh — представляет часы числом от 01 до 12, т. е. в 12-часовом виде.
  • H — представляет часы числом от 0 до 23, т. е. в 24-часовом виде.
  • HH — представляет часы числом от 00 до 23, т. е. в 24-часовом виде.
  • m — представляет минуты как число от 0 до 59.
  • mm — представляет минуты как число от 00 до 59.
  • M — представляет месяц как число от 1 до 12.
  • MM — представляет месяц как число от 01 до 12.
  • MMM — представляет сокращенное название месяца (согласно настройкам ОС).
  • MMMM — представляет полное название месяца (согласно настройкам ОС).
  • s — представляет секунды как число от 0 до 59.
  • ss — представляет секунды как число от 00 до 59.
  • y — представляет год как число из одной или двух цифр.
  • yy — представляет год как число из двух цифр.
  • yyyy — представляет год как четырехзначное число.
  • unixtime — представляет время в формате Unix (кол-во секунд с 01.01.1970 г.) (TK v1.1 и старше)

Важно!

Символы «/» (косая черта) и «:» (двоеточие) преобразуются в разделители даты и времени в соответствии с настройками системы, используйте экранирование символом «\». Например, yyyy\/MM соответствует 2009/12, а HH\\:mm соответствует 23:22.
С полным списком форматов можно ознакомиться в справочнике MSDN (на русском).

Примеры:

d.m.Y выводит 1.5.09
d MMMM YYYY выводит 1 мая 2009
dd/mm/YYYY HH\\:mm\\:ss выводит 01/05/2009 14:30:10 (не забывайте экранировать двоеточия!)