| Параметр | Описание | Формат | По-умолчанию |
|---|---|---|---|
| config | Загрузка выборочной конфигурации | Имя конфигурационного файла | default |
Файл конфигурации может включать значения различных параметров Ditto, избавляя от неудобств, связанных с ограничениями, накладываемыми MODx на значения параметров сниппетов (нельзя использовать &, `, <enter> т.п.). Примечание. Файлы конфигурации сохраняются в папке &ditto_base/configs/. Их имена имею формат &config.config.php |
|||
| dateFormat | Формат времени для | Формат времени для PHP | LANG |
Определяем формат времени, которое выводится с помощью плейсхолдера Значения: Любой валидный формат времени, который соответствует правилам функции PHP - strftime. По умолчанию: [LANG] Пример: &dateFormat=`%d.%m.%Y` Результат: 09.06.2009 |
|||
| dateSource | Источник определяющий значение [+date+] | Поле с датой | createdon |
Значения: Любое значение времени в формате UNIX timestamp изполя MODx или TV-параметра, как например createdon, pub_date, or editedon. |
|||
| debug | Включить / выключить режим отладки | 0 | 1 | 0 - выкл |
Режим отладки позволяет разобраться в сложных и непонятных ситуациях. Особенно актуальная возможндость для крупных сайтов, где множество вызовов Ditto могут конфликтовать между собой. При включенном режиме отладки помимо результатов работы выводится множество полезной для разработчика информации (все параметры, список документов результата, их ID и т.п.) |
|||
| depth | Глубина поиска документов | число | 1 |
| Число уровней в глубину для поиска документов. Документы будут найдены внутри документов-контейнеров, указанных в &startID и &parents и вложенных документов-контейнеров до уровня указанного в &depth. Т.е. если этот параметр равен 1, то будут брать только непосредственно дочерние документы, указанных в &startID и &parents. Если &depth = 2, в поиск пройдет еще и в дочерних. |
|||
| display | Число отображаемых документов | число | all | 3 |
Значения:
|
|||
| ditto_base | Расположение фалов Ditto | Папка со слэшем на конце | [(base_path)]assets/snippets/ditto/ |
| Папка со слэшем на конце, указывающая размещение фалов Ditto на сервере. Как правило этот параметр изменять не приходится. |
|||
| documents | Список ID документов для результата | Числа через запятую | пусто |
| Этот параметр должен сожержать список ID'ов тех документов, которые будут отображены в результатах. Т. е. можно жестко задать список документов, которые будут отображаться. |
|||
| extenders | Имена расширений | Расширения через запятую | пусто |
Указывает Ditto, какие расширения следует загрузить. Пример расширения с комментариями (на английском) иожно найти по пути: &ditto_base/extenders/example.extender.inc.php Примечение. Все расширения находятся в папке &ditto_base/extenders/ и имена файлов имею формат: name.extender.inc.php |
|||
| filter | Фильтр для отсеивания документов | список фильтров | NULL |
Используется формат поле,критерий, режим с запятой между значениями *Mode* - *Meaning*
@EVAL: @EVAL in filtersworks the same as it does in MODx exect it can only be used with basicfiltering, not custom filtering (tagging, etc). Make sure that you return thevalue you wish Ditto to filter by and that the code is valid PHP. |
|||
| format | Используемый формат для вывода | html | json | xml | atom | rss | html |
| Ditto умеет работать с различными форматами данных. Например, он может выводить RSS ленту новостей или данные в XML формате. |
|||
| globalFilterDelimiter | Разделитель правил фильтра | символ | | |
Значение: любой сивол, который не будет использоваться в правиле фильтра |
|||
| hiddenFields | Возвращать необработанные поля | список полей | NULL |
Значения: Любое название параметра MODx или TV-параметра, перечисленные череззапятую. |
|||
| hideFolders | Скрывать документы-контейнеры | 0 | 1 | 0 |
Значения:
|
|||
| id | Унакальный ID сессии Ditto | Строка (чувствительна к регистру) | пусто |
| Уникальный идентификатор нужен главным образом тогда, когданеобходимо использовать более одного вызова Ditto на странице, причемактуален этот параметр тогда, когда для более чем одного вызова Dittoиспользуются глобальные плэйсхолдеры. К примеру, Вы выводите наодной странице спосок новостей и список последних публикаций, причемоба списка имеют пэйджер. Если Вы вставите дважды [+pages+], то обапэйджера будут управлять двумя списками сразу. Это во-первых. Аво-вторых оба пэйджера буду отражать страницы первого списка. Т.е.когда MODx обработает первый вызов, он заменит оба плэйсхолдера [+pages+] на это значение. А список страниц второго списка никуда непопадет. Так вот в таком случае следует использовать для каждого вызова Ditto свой id. А глобальные плэйсхолдеры примут вид [+id_placeholder+]. Символ подчеркивания между идентификатором и названием плэйсхолдера добавится автоматически. |
|||
| keywords | Использование выборки ключевых слов | 0 | 1 | 0 |
Примечание: Используется как [+keywords+] или источник tagData Значения:
|
|||
| language | язык Ditton | Название языкового файла | english |
В языковых файлах Ditto хранятся шаблоны, используемые по-умолчанию, описания ошибок и уведомления. Примечание. Ditto сначала загружает свой стандартный языковой файл, а уже после этого тот файл, что указан в данном параметре. Таким образом, если в файле указанном пользователем нет какой-либо строки, она будет использована из стандартного файла. Примечание. Языковые файлы находятся в папке &ditto_base/lang/. Имена имею формат: &language.inc.php |
|||
| localFilterDelimiter | Разделитель параметров фильтра | символ | , |
Значение: любой сивбол, который не будет использоваться в параметре фильтра |
|||
| noResults | Текст выводимый если нет результата | текст | чанк | LANG |
Значения: Любое текст или название чанка |
|||
| paginate | Включает / выключает разбиение по страницам | 0 | 1 | 0 - выкл |
| Включает / выключает разбиение по страницам выдачи. На каждой странице выведется &show документов. Для вывода пэйджера используются глобальные плэйсхолдеры: [+next+] – Кнопка «Следующее» |
|||
| paginateAlwaysShowLinks | Показывать ли [+next+] и [+previous+] всегда | 0 | 1 | 0 |
| В случае если страницы для перехода нет (крайние страницы), то ссылка Previous или Next будет показана в виде текста без ссылки и будет заключена в тэг <spanclass="ditto_off">Privious</span> Значения:
|
|||
| parents | Идентификаторы контейнеров | Список ID через запятую | [*id*] |
| Указывает Ditto список идентификаторов (id) документов-контейнеров, откуда будут браться документы для вывода Ditto. Документы беруться до глубины &depth. |
|||
| phx | Использование PHx форматирования | 0 | 1 | 1 |
В Ditto имеетвы встроенный парсер PHx. Эта опция включает / выключает его. |
|||
| queryLimit | Лимит на запрос в базе | число | 0 | 0 |
Значения:
|
|||
| removeChunk | Названия вырезаемых чанков | список чанков | NULL |
Примечание: Обычно используется для удаления комментариев Значения: Любое название чанка, которое используется привыводе |
|||
| save | Сохранить результат в плэйсхолдер | 0 | 1 | 2 | 3 | 0 |
Значения:
|
|||
| seeThruUnpub | Смотреть сквозь неопубликованные документы | 0 | 1 | 0 |
Примечание: Используется если глубина (&depth) больше 1 Значения:
|
|||
| showInMenuOnly | Показывать только документы видимые в меню | 0 | 1 | 0 |
Значения:
|
|||
| showPublishedOnly | Показывать только опубликованные документы | 0 | 1 | 1 |
Значения:
По умолчанию: 1 - показывать только опубликованные документы |
|||
| sortBy | параметр используемый для сортировки | параметр | createdon |
Значения: Любое поле документа или TV-параметр |
|||
| sortDir | Сортировка документов | ASC | DESC | DESC |
Значения:
|
|||
| start | Пропуск начальных документов | число | 0 |
Значения: любое число |
|||
| startID | Папка, откуда берутся документы | ID документа-контеинера | [*id*] |
| Аналогично &parents, только в &startID указывается всего один документ-контейнер. |
|||
| total | Число возвращаемых документов | число | all | all |
Значения:
|
|||
| tpl | шаблон для записи | чанк | код | файл | LANG |
Значения:
|
|||
| tplAlt | Шаблон для четных документов | чанк | код | файл | &tpl |
Значения:
|
|||
| tplCurrentDocument | Шаблон текущего документа | чанк | код | файл | &tpl |
Значения:
|
|||
| tplFirst | Шаблон для первого документа | чанк | код | файл | &tpl |
Значения:
|
|||
| tplLast | Шаблон для последнего документа | чанк | код | файл | &tpl |
Значения:
|
|||
| tplPaginateNext | Шаблон оформления ссылки Next. | чанк | код | файл | LANG |
| Значения:
|
|||
| tplPaginatePrevious | Шаблон оформления ссылки Previous. | чанк | код | файл | LANG |
Значения:
|
|||
| tplTrunc | Шаблон для [+link+] | чанк | код | файл | truncText |
Значения:
Плэйсхолдеры:
|
|||
| trunc | Включить обрезание для [+summary+] | 0 | 1 | 1 |
Значения:
|
|||
| truncAt | Текст, служащий разделителем для [+summary+] | Любой уникальный текст | <!-- splitter --> |
Значения: Любой уникальный текст или код, который содержится в содержании каждого документа |
|||
| truncLen | Ограничение длины в [+summary+]. | число | 300 |
Значения: Любое число больше чем &truncOffset |
|||
| truncOffset | Количество "блуждающих" символов от truncLen | число | 30 |
Значения: Любое число не превышающее &truncLen |
|||
| truncText | Текст ссылки в [+link+] | текст | html-код | Read more... |
Значения: Любой текст или отрывок html-кода |
|||
| where | Специальное условие для запроса | MySQL WHERE | NULL |
Значения: Любое валидное выражение MySQL WHERE. Примечание: Используется только для параметров документов.Не поддерживает TV-параметры. |
|||