sitemapFriend
Последнее обновление not available | История страницы | Улучшить эту страницу | Сообщить о проблеме
Support the team building MODX with a monthly donation.
The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.
Backers
Budget
$204 per month—let's make that $500!
Learn moreWhat is sitemapFriend?¶
Этот сниппет генерирует sitemap: Google XML sitemap, HTML sitemap и/или любой пользовательский формат.
Requirements¶
- MODX Revolution 2.1.5 или новее
- PHP5 или новее
History¶
sitemapFriend написал Mihai Sucan на основе сниппета GoogleSiteMap Shaun McCormick. Релиз 16 ноября 2010 года. Mihai прекратил разработку под Modx, плагин поддерживает Jérôme Perrin.
Download¶
Скачайте через менеджер MODX Revolution в Package Management или из MODX Extras Repository.
Development and Bug reporting¶
Feature requests и баги на github.
Usage¶
[[sitemapFriend? &type=`xml`]]
HTML sitemap:
[[sitemapFriend? &type=`html`]]
Для пользовательского формата создайте чанки и укажите их сниппету. Список шаблонов ниже.
Подсказка: используйте сниппет getCache для управления кэшем sitemap.
[[!getCache? &element=`sitemapFriend` &cacheKey=`sitemap` &cacheExpires=`21600` &type=`html`]]
Properties¶
Сниппет генерирует почти любой sitemap. Вывод настраивают свойства ниже. Свойства задают в вызове или в property sets.
Output Properties¶
| Name | Description | Default |
|---|---|---|
| type | Тип sitemap: xml или html. От type зависят значения по умолчанию других свойств. | html |
| titleField | Поле заголовка: pagetitle, longtitle, menutitle. Fallback на pagetitle, чтобы заголовок не был пустым. | pagetitle |
| urlScheme | URL scheme для не-XML sitemap: http, https, full, abs и т.д. См. $modx->makeUrl(). | |
| Для XML sitemap всегда full. | abs | |
| startId | Строить sitemap от указанного ID ресурса. | 0 |
| contexts | Ограничить указанными контекстами. Пусто: ресурсы текущего Context. Список через запятую. | |
| showDeleted | Включать удалённые ресурсы? | false |
| showUpublished | Включать неопубликованные ресурсы? | false |
| onlySearchable | Только searchable ресурсы? | true |
| showHidden | Включать ресурсы, скрытые в меню? | true |
| maxDepth | Максимальная глубина дерева. Пусто или 0: все ресурсы. | 0 |
| onlyTemplates | Список ID шаблонов через запятую. | |
| skipTemplates | Список ID шаблонов для пропуска. | |
| includeWebLinks | Включать weblink ресурсы? | false |
| excludeResources | Список ID для полного исключения из sitemap. Дочерние тоже исключаются. Ресурсы из опций Modx error_page, site_unavailable_page, unauthorized_page и сама страница sitemap исключаются всегда. | |
| skipResources | Список ID для скрытия из sitemap. Дочерние НЕ исключаются. | |
| includeResources | Список ID для принудительного включения, даже если showDeleted, showUnpublished, onlySearchable и showHidden отфильтровали бы ресурс. | |
| excludeChildrenOf | Список ID, чьи дочерние не включаются в sitemap. Сами ресурсы включаются, пропускаются только дети. | |
| parentTitles | Включать заголовки родительских ресурсов? | false |
| parentTitlesReversed | Если parentTitles включён, показывать заголовки в обратном порядке? | false |
| titleSeparator | Разделитель заголовков при parentTitles. | - |
| sortBy | Поле ресурса для сортировки. | menuindex |
| sortDir | Направление сортировки. | ASC |
| lastmodFormat | Формат lastmod для не-XML sitemap. См. PHP date() function. | |
| Для XML sitemap всегда c (ISO 8601). | F j, Y, g:i a |
Templating Properties¶
| Name | Description | Default |
|---|---|---|
| tplOuter | Чанк для не-XML sitemap, внешний контейнер всего вывода. | sitemap_html_outer.chunk.tpl |
| tplItem | Чанк для не-XML sitemap, каждый элемент. | |
| Дочерние элементы оборачиваются в tplContainer. | sitemap_html_item.chunk.tpl | |
| tplContainer | Чанк для не-XML sitemap, обёртка дочерних ресурсов папки. | sitemap_html_container.chunk.tpl |
Chunks¶
sitemap_html_outer.chunk.tpl¶
Чанк по умолчанию, внешний контейнер всего вывода sitemap.
Default Value¶
<ul id="sitemap">
[[+items]]
</ul>
Available placeholders¶
| Name | Description |
|---|---|
| startId | ID стартового ресурса sitemap. |
| items | Вся строка вывода sitemap. |
sitemap_html_item.chunk.tpl¶
Чанк по умолчанию для каждого элемента.
Default Value¶
<li>
<a href="[[+url]]">[[+title]]</a>
[[+items]]
</li>
Available placeholders¶
| Name | Description |
|---|---|
| parent | ID родительского ресурса. |
| id | ID обрабатываемого ресурса. |
| url | URL ресурса. |
| lastmod | Дата последнего изменения ресурса. |
| title | Заголовок ресурса. Может включать заголовки родителей, если parentTitles = true. |
| items | Вывод sitemap для дочерних ресурсов. Позволяет вкладывать ресурсы, как в HTML sitemap. См. sitemap_html_item.chunk.tpl |
| changefreq | Частота изменений по lastmod. Только для XML sitemap. |
| priority | Приоритет по lastmod. Только для XML sitemap. |
sitemap_html_container.chunk.tpl¶
Чанк по умолчанию, обёртка дочерних ресурсов папки.
Default Value¶
<ul>
[[+items]]
</ul>
Available placeholders¶
| Name | Description |
|---|---|
| depth | Текущая глубина ресурса. |
| id | Текущий ID ресурса, для которого сгенерирован вывод. |
| items | Строка вывода со списком дочерних ресурсов. |
sitemap_xml_outer.chunk.tpl¶
Чанк по умолчанию для XML sitemap, внешний контейнер.
Default Value¶
<?xml version="1.0" encoding="[[++modx_charset]]"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
[[+items]]
</urlset>
sitemap_xml_item.chunk.tpl¶
Чанк по умолчанию для XML sitemap, каждый элемент.
Default Value¶
<url>
<loc>[[+url]]</loc>
<lastmod>[[+lastmod]]</lastmod>
<changefreq>[[+changefreq]]</changefreq>
<priority>[[+priority]]</priority>
</url>
[[+items]]
Support the team building MODX with a monthly donation.
The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.
Backers
Budget
$204 per month—let's make that $500!
Learn more