getRelated

getRelated: сниппет MODX Revolution для списка связанных ресурсов.

Алгоритм настраивается через свойство &fields: поля для сравнения и вес каждого поля.

Ссылки и история¶

Исходники Github: https://github.com/Mark-H/getRelated Баги и feature requests: https://github.com/Mark-H/getRelated/Issues

Обсуждение: http://forums.modx.com/thread/71009/getrelated-automatically-listing-related-resources-for-revolution

Разработчик Mark Hamstra для Vierkante Meter.

Как работает getRelated (обязательно к прочтению)¶

Чтобы настроить свойства, нужно понимать алгоритм.

Шаги при сборе связанных ресурсов:

1. getRelated берёт базовый ресурс, обычно текущий. Поля &fields разбираются на отдельные слова.
2. Stopwords из языкового лексикона отфильтровывают частые слова.
3. По найденным словам выполняется запрос в заданных contexts и parents. Это comparison sample. Для полей ресурса и TV по свойству fields.
4. Sample обрабатывается с весами из &fields, считается ranking каждого ресурса.
5. Результаты сортируются по ranking и выводятся через tpl.

Свойства ниже настраивают один или несколько шагов. В таблице указан шаг для каждого свойства.

Свойства сниппета¶

<h3>[[%getrelated.pagesfound? &namespace=`getrelated` &count=`[[+count]]`]]</h3>
<ul>
  [[+wrapper]]
</ul>
``` | relatedOuter |
| tplRow | 5 | Chunk name to use as row template, used in every related resource.

The placeholders you can use include the fields in your &fields property (minus TVs), as well as those in the returnFields property. The resource ID is always accessible with `[[+id]]`, the ranking (the result of the algorithm) as `[[+rank]]` and the number of the result with `[[+idx]]`.

Default chunk (stored as file in core/components/getrelated/elements/chunks/):

``` php
<li>
  <a href="[[~[[+id]]]]" title="[[+longtitle:default=`[[+pagetitle]]`]]">
    [[+longtitle:default=`[[+pagetitle]]`]] ([[+rank]])
  </a>
</li>
``` | relatedRow |
| noResults | 5 | Text or output when there are no related resources found. (Hint: you could add a `[[$chunk]]` to the property to output that when there are no results: &noResults=``[[$chunkname]]``) | "No related pages found." |
| rowSeparator | 5 | String to use as separator between rows. | \\n |
| debug |  | \[1|0\] Enable/disable debug mode. When enabled it will dump lots of information on screen. | 0 |

## Использование

Нет веской причины вызывать сниппет без кэша. На большом сайте это сильно бьёт по производительности. Сниппет смотрит на данные ресурсов, кэш сбрасывается при обновлении ресурса. Между обновлениями getRelated не видит изменений. НЕ ВЫЗЫВАЙТЕ БЕЗ КЭША. Без кэша тег с восклицательным знаком: `[[!snippetname]]`. Нужен вызов **без** восклицательного знака: `[[snippetname]]`.



Минимальный вызов:

``` php
[[getRelated]]

Список до трёх связанных ресурсов по pagetitle и introtext. Уточняйте через &fields: TV тегов, категорий или поле с ключевыми словами.

Оптимизация производительности¶

Если getRelated тормозит:

1. Вызывайте с кэшем. Без кэша с производительностью не помогу.
2. Не используйте content, данных слишком много.
3. Запрос sample может быть слишком широким:
   1. Нет перевода лексикона для вашего языка, отсекаются английские stopwords. Переведите English Lexicon и отправьте автору. Длинный список stop words в файле не переводите, возьмите список stopwords для вашего языка из надёжного источника.
   2. Все ресурсы содержат одни и те же слова (название компании, продукта). Включите debug (&debug=1) и проверьте Match Data. Добавьте лишние слова в "getrelated.stopwords" лексикон: System > Lexicon Management, namespace "getrelated", нужный язык. Для включения в пакет: bug report.
4. Слишком много связанных ресурсов:
   1. Уменьшите sample sizes. По умолчанию ~1 сек на первую загрузку (дальше из кэша). tvSample можно снизить до 50 на TV. Три TV: с 375 до 150 ресурсов в обработке. Порядок sample меняйте через tvSort, tvSortDir, fieldSort, fieldSortDir. По умолчанию createdon, новые первые.
5. returnTVs с многими TV и большим result set может тормозить. Ограничьте result set и берите только нужные TV.
6. Возможен баг. Напишите на форум или Github (ссылки выше).