Сниппет Ditto 2

Сниппет Ditto 2

Описание

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

Автор

Mark Kaplan

Версия

2.0.2

Параметры

ditto_base

Расположение фалов Ditto

Значения: Любая валидная папка со слэшем на конце.

По умолчанию: [(base_path)]assets/snippets/ditto/

id

Уникальный ID для Ditto для взаимодействия с другими скриптами (например Reflect) и уникальный параметр URL

Значения: любая комбинация символов a-z, подчеркивания и чисел 0-9

Примечание: Чувствительно к регистру

По умолчанию: "" - пустое

language

Язык для умолчаний, отладочной информации и сообщений об ошибке.

Значения: любое название языка указывающее на файл в папке &ditto_base/lang folder

По умолчанию: "english"

format

Используемый формат для вывода

Значения:

"html" "json" "xml" "atom" "rss"

По умолчанию: "html"

config

Загрузка выборочной конфигурации

Значения:

"default" - стандартный пустой конфигурационный файл CONFIG_NAME - другой конфигурационный файл установленный в папку configs или другую, путь к которой определяется через @FILE

По умолчанию: "default"

Связанные:  <extenders>

debug

Выводит отладочную информацию

Значения:

0 - off 1 - on

По умолчанию: 0 - off

Связанные: <debug>

phx

Использование PHx форматирования

Значения:

0 - off 1 - on

По умолчанию: 1 - on

extenders

Загрузка расширений для увеличения функциональности Ditto

Значения: Любой файл расширения, установленный в папку extenders или другую, путь к которой определяется через @FILE

По умолчанию: [NULL]

Связанные:  <config>

parents

Идентификатор контейнера для Ditto где будут использоваться дочерние документы для [IDs of containers for Ditto to retrieve their children to &depth depth]

Значения: Любой валидный документ, отмеченный как контейнер(?)

По умолчанию: Текущий документ

Связанные:

<documents> <depth>

startID

Идентификатор папки из которой берутся документы для формирования результата.

Значения: Любой валидный документ, отмеченный как контейнер(?)

По умолчанию: Текущий документ

documents

Идентификатор документа который возвращает Ditto (? Куда и что возвращает?)

Значения: Любой валидный документ, отмеченный как контейнер(?)

По умолчанию: None

Связанные:  <parents>

depth

Число уровней в глубину для документов

Значения: Любое число больше или равное 1

По умолчанию: 1

Связанные: <seeThruUnpub>

paginate

Разбивать результат на страницы по определенному &show числу

Значения:

0 - off 1 - on

По умолчанию: 0 - off

Связанные:

<paginateAlwaysShowLinks> <paginateSplitterCharacter> <show>

dateSource

Источник определяющий значение [+date+]

Значения: Любое значение времени в формате UNIX timestamp из поля MODx или TV-параметра, как например createdon, pub_date, or editedon.

По умолчанию: "createdon"

Связанные: <dateFormat>

dateFormat

Формат времени, который будет использован для [+date+]

Значения: Любой валидный формат времени PHP

По умолчанию: [LANG]

Связанные: <dateSource>

display

Число документов при отображении результата

Значения:

# - Любое число "all" - Все найденные документы

По умолчанию: 3

Связанные:

<queryLimit> <total>

total

Число возвращаемых документов

Значения:

# - любое число "all" - Все найденные документы

По умолчанию: "all" - All documents found

Связанные:

<show> <queryLimit>

showPublishedOnly

Показывать только опубликованные документы

Значения:

0 - показывать только неопубликованные документы 1 - показывать только опубликованные документы

По умолчанию: 1 - показывать только опубликованные документы

Связанные:

<seeThruUnpub> <hideFolders> <showPublishedOnly> <where>

Сделать: Разрешить при установке значения 0 показывать одновременно опубликованные и неопубликованные документы

showInMenuOnly

Показывать только документы, которые видны в меню

Значения:

0 - показывать все документы 1 - показывать только документы у которых поставлен флаг «Показывать в меню»

По умолчанию: 0 - показывать все документы

Связанные:

<seeThruUnpub> <hideFolders> <where>

hideFolders

Не показывать папки в результате

Значения:

0 - оставить папки 1 - исключить папки

По умолчанию: 0 - оставить папки

Связанные:

<seeThruUnpub> <showInMenuOnly> <where>

seeThruUnpub

Смотреть сквозь неопубликованные папки и использовать их дочерние документы. Примечание: Используется если глубина (&depth) больше 1

Значения:

0 - off 1 - on

По умолчанию: 0 - off

Связанные:

<hideFolders> <showInMenuOnly> <where>

queryLimit

Число документов запрашиваемых из базы (аналог MySQL LIMIT)

Значения:

# - любое число 0 - автоматически

По умолчанию: 0 - автоматически

Связанные: <where>

where

Выборочное значение MySQL WHERE

Значения: Любое валидное выражение MySQL WHERE.

Примечание: Используется только для параметров документов. Не поддерживает TV-параметры.

По умолчанию: [NULL]

Связанные: <queryLimit>

noResults

Текст или чанк для отображения, когда нет результата

Значения: Любое текст или название чанка

По умолчанию: [LANG]

removeChunk

Названия чанков, которые будут вырезаться из содержимого, перечисленные через запятую

Примечание: Обычно используется для удаления комментариев

Значения: Любое название чанка, которое используется при выводе

По умолчанию: [NULL]

hiddenFields

Позволить возвращать поля в шаблоне, которые парсер не смог обработать как например метки или [*поля*] (?Не понятно о чем речь. Будет возвращать конструкцию типа [+auhor+]?)

Значения: Любое название параметра MODx или TV-параметра, перечисленные через запятую.

По умолчанию: [NULL]

sortDir

Указания по сортировке документов

Значения:

ASC - по возрастанию DESC - по убыванию

По умолчанию: "DESC"

Связанные: <sortBy>

sortBy

Поле, по которому будут сортироваться документы

Значения: Любое поле документа или TV-параметр

По умолчанию: "createdon"

Связанные: <sortDir>

start

число документов пропущенных в результате (?сколько пропустить документов с начала?)

Значения: любое число

По умолчанию: 0

globalFilterDelimiter

Filter delimiter used to separate filters in the filter string (?вообще не понятно о чем речь?)

Значения: Any character not used in the filters (? Тоже не ясно?)

По умолчанию: "|"

Связанные:

<localFilterDelimiter> <filter> <parseFilters>

localFilterDelimiter

Delimiter used to separate individual parameters within each filter string

Значения: Any character not used in the filter itself

По умолчанию: ","

Связанные:

<globalFilterDelimiter> <filter> <parseFilters>

filter

Показывать только элементы соответствующие критерию

Используется формат поле, критерий, режим с запятой между значениями (?это надо разобрать подробнее. Вроде штука интересная, но не совсем ясная?)

*Mode* - *Meaning*

1 - != 2 - == 3 - < 4 - > 5 - <= 6 - >= 7 - Текста нет в значении поля 8 - Текст в значении поля

@EVAL:

 @EVAL in filters works the same as it does in MODx exect it can only be used

  with basic filtering, not custom filtering (tagging, etc). Make sure that

    you return the value you wish Ditto to filter by and that the code is valid PHP.

По умолчанию: [NULL]

Связанные:

<localFilterDelimiter> <globalFilterDelimiter> <parseFilters>

keywords

включить выборку ассоциированных ключевых слов для каждого документа (?не совсем ясно что это значит?)

Примечание: Используется как [+keywords+] или источник tagData (?тоже не ясно что это значит?)

Значения:

0 - off 1 - on

По умолчанию: 0 - off

save

Сохранение объекта Ditto и результатов в значении (placeholders) для использования в других сниппетах

Значения:

0 - off; returns output 1 - remaining; returns output 2 - all; 3 - all; returns ph only

По умолчанию: 0 - off; returns output

tpl

Использовать заданный чанк для форматирования документов

Значения:

Любое валидное название чанка Код через @CODE Файл через @FILE

По умолчанию: [LANG]

tplFirst

Использовать заданный чанк для форматирования первого документа

Значения:

Любое валидное название чанка Код через @CODE Файл через @FILE

По умолчанию: &tpl

tplLast

Использовать заданный чанк для форматирования первого документа

Значения:

Любое валидное название чанка Код через @CODE Файл через @FILE

По умолчанию: &tpl

Расширения

summary

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

Использование: [+summary+]

dateFilter

вспомогательный фильтр для Reflect и других фильтров основанных на дате.

request

включает поддержку изменения параметров Ditto через URL.

Примечание: все параметры должны быть с префиксом ditto_

tagging

коллекция параметров, функций и классов, расширяющих функциональность Ditto для Теггирования.

Комментарий

Из спецификации пока исключены следующие параметры:

randomize tplAlt tplCurrentDocument

Подстановщики

Useful Ditto Placeholders

[~[+id+]~] - Create a full URL based on the ID. Does not create a link itself. Example:

<h3><a href="[~[+id+]~]">[+title+]</a></h3>

[+title+] - Contents of one of document title fields. There's probably an order in which it tries to find a title. [+summary+] - Either introtext in full if set, or the first part of content. [+link+] - Creates a link to the document, with the text "Read more...". [+author+] - The name of the author. Is this based on createdby or editedby? [+date+] - The date, in the set format. Set as createdon by default (editedon & pub_date are options)and follows this format string.

Useful Document-Specific Values

[+pagetitle+] - The title of the document. [+longtitle+] - The longtitle of the document. [+description+] - The description of the document. [+introtext+] - The summary of the document. [+content+] - The content of the document. [+alias+] - The alias of the page. Used in creating Friendly URLs. [+menutitle+] - The menu title of the document.

Other Document-Specific Values

[+id+] - the integer id for the document. [+parent+] - the integer of the parent [+isfolder+] - Integer; true (1) if the document is a folder and false (0) if it is not. [+menuindex+] - the menu index (sort order) integer [+hidemenu+] - Returns 1 (true) or 0 (false) - whether this item will show in the menu or not. [+type+] - Returns a string of either 'document' for pages or 'reference' for links [+contentType+] - Returns string of content type specified in manager Content Type drop down menu. [+published+] - integer declaring publish status (0=no, 1=yes) [+pub_date+] - Date document begins viewability (in seconds since January 1, 1970). Note - when this is set, ['published'] is automatically set to true (1) [+unpub_date+] - Date document ends viewability (in seconds since January 1, 1970). Note- setting this will NOT have any effect on the status of the ['published'] setting [+richtext+] - true (1) or false (0), used to specify if a rich text editor should be used in the manager. [+template+] - integer template id to be used with this content. [+searchable+] - Returns 1 (true) or 0 (false) to designate whether this page content should be searchable. [+cacheable+] - Returns 1 (true) or 0 (false) if this page should be cached. This is set to false by default so dynamic snippets function properly. [+createdby+] - Returns integer id number of user who created content. [+createdon+] - Date (in seconds since January 1, 1970) when the content was created. [+editedby+] - Integer id number of the user who last edited the content. [+editedon+] - Returns date of the last edit (in seconds since January 1, 1970). [+deleted+] - Returns 1 (true) or 0 (false). When true, this document will appear in the recyling bin until the recycling bin gets emptied. At that point, the record is removed entirely from the database (REALLY deleted). [+deletedon+] - Returns date of document deletion (in seconds since January 1, 1970). [+deletedby+] - Returns the integer id of the person who deleted the document. [+donthit+] - True (1) or False (0) to indicate whether or not the page registers in the site statics/user tracking. [+haskeywords+] - True (1) or False (0) to indicate if the document has keywords assignded to it or not. [+hasmetatag+] - True (1) or False (0) to indicate if the document has metatags assigned to it or not. [+privateweb+] - True (1) or False (0) to indicate if the document is private for Web Users or not. [+privatemgr+] - True (1) or False (0) to indicate if the document is private for Manager users or not. [+content_dispo+] - String of 'inline' or 'attachment'. Inline documents are displayed in web browsers. Attachment disposition causes the document to be downloaded to the local machine through the web browser file download dialog box.

Ditto MODx Placeholders

[+next+] - next button [+previous+] - previous button [+splitter+] - splitter if always show is 0 [+pages+] - page list [+totalpages+] - total number of pages [+start+] - the # of the first item shown [+stop+] - the # of the last item shown [+current+] - the # of current page shown [+total+] - the total # of pages [+item[x]+] – rendered output of an individual document

Ditto-Specific TV Method

[+tvtemplatevariablename+] – where templatevariablename is the name of your TV - ie add tv to the start (NOTE: In Ditto 2.x you dont need to add tv prefix, i. e. you can use [+templatevariablename+])

Для обращения к подстановщику надо использовать следующий синтаксис

[+id_placeholder+], где id – идентификатор, используемый при вызове сниппетов; placeholder – подстановщик.

Пример вызова сниппета:

[!Ditto? &tpl=`commenttpl` &dateFormat=`%d.%m.%Y` &sortBy=`creatdon` &noResults=`no` &hideFolders=`1` &truncText=`читаем...` &depth=`1` &display=`all` &paginate=`1` &filter=`parametr, value, condition` &tagData=`subject` !]