SitemapFriend

Опубликовано: 28 Сен 2015

SitemapFriend сниппет  для MODx Revolution предоставляющий все функциональные возможности  для создания карты сайта.

Код основывается на сниппете GoogleSiteMap автор которого Шон Маккормик.

Установка

Скачать sitemapFriend из репозитория MODx. Или найти sitemapFriend в менеджере пакетов MODx  Revolution и установить оттуда.

Примеры использования

Создание HTML-страницы:

[ [!sitemapFriend? &type=`html`]]

Создание Sitemap XML:

[ [!sitemapFriend? &type=`xml`]]

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

Свойства

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

&type - тип карты сайта: xml или html. В зависимости от выбора другие свойства меняют свои значения по умолчанию.
&urlScheme - URL схема: http, https, full, abs,  и т.д. См. $ MODx-> makeUrl () в документации. По умолчанию для HTML: abs. Для типа XML: full.
&startId – ID ресурса с которого начнется формирование карты. Корневой ресурс.  Значение по умолчанию: 0.
&contexts - Ограничение до заданного контекста. Если пусто, будет захватывать ресурсы от текущего контекста. По умолчанию пустой, может поддерживать список контекстов разделенных запятыми.
&showDeleted - Если  true, будет включать в себя удалил ресурсов. По умолчанию false.
&showUpublished - Если true, будет включать неопубликованные ресурсы. По умолчанию false.
&onlySearchable - Если true, будут включать только для поиска ресурсов. По умолчанию это true.
&showHidden - Если true, будет включать в себя ресурсы, которые не видны в меню. По умолчанию это true.
&maxDepth - максимальная глубина выборки ресурсов вниз по дереву. Если установлено значение пусто или 0, будет захватывать все ресурсы.
&onlyTemplates - разделенный запятыми список идентификаторов шаблонов для выбора. Останутся только ресурсы  с заданными шаблонами, если значение установлено.
&skipTemplates - разделенный запятыми список идентификаторов шаблонов, для пропуска. Останется только ресурсы, у которых шаблон отличный заданным заданными шаблонами, если значение установлено.
&excludeResources - разделенный запятыми список ресурсов, для исключения их из карты сайта. Дочерние ресурсы будут также исключены. Ресурсы которые выдают ошибки error_page, site_unavailable_page, unauthorized_pa  автоматически будут исключены из карты сайта.
&skipResources - разделенный запятыми список ресурсов, для исключения их из карты сайта.. Дочерние ресурсы не будут исключены.
&includeResources - разделенный запятыми список ресурсов для отображения в карте сайта, даже если данный ресурс скрыт, удален или не опубликован в противном случае будут отфильтрованы с помошью параметров ShowDeleted, showUnpublished, onlySearchable и showHidden.
&excludeChildrenOf - разделенный запятыми список ресурсов, дочерние элементы которых не будут добавлены в карту сайта. Обратите внимание, что ресурсы, которые вы здесь напишите будут включены, в дочерние нет.
&parentTitles – добавлять заголовок родительского ресурса в карту сайта. Значение по умолчанию: false.
&parentTitlesReversed - если заголовок  родительского ресурса используется, то этот параметр  устанавливает обратный порядок заголовков. По умолчанию false.
&titleSeparator - если заголовок  родительского ресурса используется, то этот параметр  устанавливает разделитель. Строка по умолчанию "-".
&sortBy - поле для сортировки результатов. Значение по умолчанию: menuindex.
&sortDir - направление для сортировки.  Значение по умолчанию: ASC.
&lastmodFormat - формат даты последнего изменения. При этом используется тот же формат что и для  PHP date() function. По умолчанию для HTML типа: "F j, Y, g:i a". Для XML-тип "c" значение всегда используется (ISO 8601 формат даты).

Шаблоны

Сниппет SitemapFriend поставляется с набором шаблонов. Никогда не редактируйте существующие чанки! Если вы это сделаете, ваши изменения будут потеряны при обновлении сниппета.  Дублируйте и переименовываете чанки шаблонов если вносите в них изменения.

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

tplItem

Чанк используется для каждого результата пункта. По умолчанию для HTML используется: sitemap_html_item, а sitemap_xml_item для XML.

Доступные плейсхолдеры:

parent - содержит идентификатор родительского ресурса.
id - идентификатор ресурса в процессе обработки.
url - адрес ресурса.
lastmod - дата последней модификации ресурса.
title - название ресурса. Может включать название родительского ресурса, если parentTitles установлен верно.
items  - содержит дочерние ресурсы, если таковые имеются. Посмотрите, как это используется в чанке sitemap_html_item.
changefreq – Частота изменения, вычисляется на основе даты последнего изменения. Доступно только для XML карты сайта.
priority  - приоритет ресурсов, снова вычисляется на основе даты последнего изменения. Доступно только для XML карты сайта.
Это как тег HTML <LI> в котором перечислены страницы вашего сайта. Он может иметь дочерние элементы, а также, завернутые внутрь tplContainer.

tplContainer

Чанк для использования в качестве оболочки для дочерних ресурсов. Это как тег  UL вокруг LI в HTML. Это свойство никогда не используется для XML-типа.

Доступные плейсхолдеры:

depth - текущая глубина ресурса.
id - ID Текущего ресурса.
items - выходная строка, в которой перечислены дочерние ресурсы.

tplOuter

Чанк используется как внешний контейнер для всей карты сайта. По умолчанию для HTML типа: sitemap_html_outer и sitemap_xml_outer для XML-типа.

Доступные плейсхолдеры:

startId  - идентификатор ресурса начала карты сайта.
items  - вывод всей карты сайта.

Комментарии (0)


Оставить комментарий




Разрешённые теги: <b><i><br>Добавить новый комментарий: