dimayakovlev.ru

DY Breadcrumbs

Описание

Плагин DY Breadcrumbs для системы управления контентом GetSimple CMS позволяет добавить на страницы веб-сайта элемент навигации “хлебные крошки” (breadcrumbs), предназначенный для указания пользователю его текущего местонахождения на веб-сайте с учётом уровня вложенности страниц.

Возможности

  • полная поддержка режима Fancy URLs: DY Breadcrumbs полностью поддерживает работу функции Fancy URLs в GetSimple CMS, предоставляя возможность навигации с использование ЧПУ (человеку понятных URL);
  • неограниченный уровень вложенности: DY Breadcrumbs позволяет отображать навигационную цепочку для страницы, находящейся на любом уровне вложенности, поддерживаемым GetSimple CMS (при включённой опции Fancy URLs, формируемые URL так же содержат в себе всю цепочку родительских страниц);
  • сохранение приватности страниц: все родительские страницы, отмеченные как “приватные”, не отображаются в навигационной цепочке и не попадают в формируемые URL(при включённой опции Fancy URLs);
  • полный контроль над оформлением: DY Breadcrumbs не использует предопределённых стилей оформления и заданных разделителей в формируемом HTML коде, что даёт полную свободу при встраивании навигационной цепочки в используемую тему оформления веб-сайта;
  • поддержка микроданных: начиная с версии DY Breadcrumbs 1.4, формируемая навигационная цепочка, имеет разметку в соответствии с требованиями словаря schema.org.

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

Для вывода “хлебных крошек” в файле шаблона оформления страницы или компоненте следует разместить вызов PHP функции:

dyGetBreadcrumbs(string  $slug = '', boolean  $home = true, string  $homeTitle = '', integer  $parentTitleLength, integer  $currentTitleLength, boolean  $fullPath = false, boolean  $useMicrodata = true, boolean  $useMenuData = false, string  $tag = 'li')

Параметры, принимаемые функцией dyGetBreadcrumbs:

string$slug

Адрес страницы, для которой формируется навигационная цепочка. Если пустая строка, используется адрес текущей страницы (только начиная с версии 1.5, в ранних версиях плагина задание адреса страницы обязательно)

boolean$home

Если равен true, в навигационную цепочку в качестве корневого элемента включается главная страница сайта, даже если она не является частью дерева потомков страницы

string$homeTitle

Название, используемое для корневого элемента навигационной цепочки. Если не задано, используется название из языкового файла

integer$parentTitleLength

Задаёт длину названий для родительских элементов в навигационной цепочке. Если равен 0, выводятся полные названия

integer$currentTitleLength

Задаёт длину названия страницы в навигационной цепочке. Если равен 0, выводится полное название

boolean$fullPath

Если равен true, адреса страниц включают всю цепочку родительских страниц, иначе - только непосредственную родительскую страницу (рекомендуемое значение)

boolean$useMicrodata

Если равен true, в HTML разметке навигационной цепочки используются микроданные (словарь schema.org)

boolean$useMenuData

Если равен true, для родительских элементов в навигационной цепочки используются названия, заданные для использования в меню, иначе используются стандартные заголовки страниц

string$tag

HTML тег, использующийся для формирования элементов навигационной цепочки. По умолчанию используется тег li. Параметр доступен начиная с версии 1.5

В результате выполнения функции dyGetBreadcrumbs на странице будет напечатан набор элементов списка (ссылки на страницы, заключённые в теги <li>), поэтому вызов функции следует заключать в HTML теги <ul> или <ol>.

Пример использования DY Breadcrumbs для вывода “хлебных крошек” на текущей странице веб-сайта:

<ol>
    <?php dyGetBreadcrumbs(get_page_slug(false), true, 'Главная', 0, 0, false, false, false); ?>;
</ol>

В результате выполнения приведённого кода будет сформирован следующий маркированный список:

<ol>
    <li><a href="http://dimayakovlev.ru/">Главная</a></li>
    <li><a href="http://dimayakovlev.ru/parent-page/">Родительская страница</a><li>
    <li class="current active">Дочерняя страница</li>
</ol>

Начиная с версии DY Breadcrumbs 1.4 при создании навигационной цепочки может использоваться семантическая разметка с использованием микроданных (словарь schema.org). При этом, формируемый HTML-код навигационной цепочки, выглядит следующим образом:

<ol itemscope itemtype="http://schema.org/BreadcrumbList">
    <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
        <a itemprop="item" href="http://dimayakovlev.ru/"><span itemprop="name">Главная</span></a><meta itemprop="position" content="1" />
    </li>
    <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
        <a itemprop="item" href="http://dimayakovlev.ru/parent-page"><span itemprop="name">Родительская страница</span></a><meta itemprop="position" content="2" />
    </li>
    <li class="current active" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
        <span itemprop="name">Дочерняя страница</span><meta itemprop="position" content="3" />
    </li>
</ol>

Для настройки внешнего вида “хлебных крошек” с целью их наилучшей интеграции в используемую тему оформления веб-сайта, следует использовать правила и селекторы CSS.

DY Breadcrumbs и Bootstrap

При использовании DY Breadcrumbs совместно с фрэймворком Bootstrap, просто добавьте класс breadcrumbs для элемента, обрамляющего выводимый список:

<ol class="breadcrumbs" itemscope itemtype="http://schema.org/BreadcrumbList">
    <?php dyGetBreadcrumbs(get_page_slug(false)); ?>
</ol>