Документация для разработчиков

Новость детально

Одностраничный компонент, осуществляющий вывод детального описание новости. Компонент стандартный и входит в дистрибутив модуля.

В визуальном редакторе компонент расположен по пути: Контент > Статьи и новости > Новость детально.

Компонент относится к модулю Информационные блоки.

Пример вызова компонента news.detail

Секции настроек компонента:

  • Основные параметры
  • Источник данных
  • Шаблоны ссылок
  • Управление режимом AJAX
  • Настройки кеширования
  • Дополнительные настройки
  • Настройки постраничной навигации
  • Настройки 404 ошибки
  • Описание параметров

    Поле Параметр Описание
    Основные параметры
    Тип информационного блока (используется только для проверки) IBLOCK_TYPE Указывается один из созданных в системе типов информационного блока.
    Код информационного блока IBLOCK_ID Для выбранного типа инфоблока указывается идентификатор информационного блока, новости из которого будут выводиться.
    ID новости ELEMENT_ID Указывается числовой код, в котором передается идентификатор новости. Поле может быть оставлено пустым, если указан Код новости.
    Код новости ELEMENT_CODE Указывается символьный код новости, из которого будут выбраны новости. Поле может быть оставлено пустым, если указан ID новости.
    Источник данных
    Показывать только активные на данный момент элементы CHECK_DATES [Y|N] При отмеченной опции будут показаны только активные на данный момент элементы.
    Поля FIELD_CODE Указываются поля, которые будут отображены на странице. Заполняется из публичной части редактора, удерживая клавишу Ctrl, либо в коде, указывая массив:
    Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
    При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже (т.е. если задан пустой массив), на странице списка будут выведены поля по умолчанию.
    Свойства PROPERTY_CODE Указываются свойства, которые будут отображены на странице. Заполняется из публичной части редактора, удерживая клавишу Ctrl, либо в коде, указывая массив. При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже, на странице детального просмотра свойства не будут выведены.
    Шаблоны ссылок
    URL страницы просмотра списка элементов (по умолчанию - из настроек инфоблока) IBLOCK_URL Указывается адрес страницы просмотра списка элементов (по умолчанию - из настроек инфоблока).
    URL страницы детального просмотра (по умолчанию - из настроек инфоблока) DETAIL_URL Указывается адрес страницы детального просмотра элемента (по умолчанию - из настроек инфоблока).
    Управление режимом AJAX
    Включить режим AJAX AJAX_MODE [Y|N] При установленной опции для компонента будет включен режим AJAX.
    Включить прокрутку к началу компонента AJAX_OPTION_JUMP [Y|N] Если пользователь совершит AJAX-переход, то при установленой опции по окончании загрузки произойдет прокрутка к началу компонента.
    Включить подгрузку стилей AJAX_OPTION_STYLE [Y|N] Если параметр принимает значение "Y", то при совершении AJAX-переходов будет происходить подгрузка и обработка списка стилей, вызванных компонентом.
    Включить эмуляцию навигации браузера AJAX_OPTION_HISTORY [Y|N] Когда пользователь выполняет AJAX-переходы, то при включенной опции можно использовать кнопки браузера "Назад" и "Вперед".
    Дополнительные настройки
    Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлен заголовок элемента.
    Устанавливать канонический URLSET_CANONICAL_URL[Y|N] При отмеченной опции страница новости будет помечена как каноническая (т.е. будет считаться основной для поисковых систем среди ее дублей).

    Каноническая ссылка строится для основного раздела элемента, а если он не задан, то для раздела с наименьшим идентификатором.
    Устанавливать заголовок окна браузераSET_BROWSER_TITLE[Y|N] При отмеченной опции будет установлен заголовок окна браузера по заданному SEO-шаблону META TITLE (см. закладку "SEO" в инфоблоке) или из свойства. Становится активным поле:
    Установить заголовок окна браузера из свойстваBROWSER_TITLEСреди всех свойств, определенных для данного инфоблока, выбирается то, в котором содержится заголовок окна браузера.
    Устанавливать ключевые слова страницыSET_META_KEYWORDS[Y|N] При отмеченной опции будут установлены ключевые слова страницы по заданному SEO-шаблону META KEYWORDS (см. закладку "SEO" в инфоблоке) или из свойства. Становится активным поле:
    Установить ключевые слова страницы из свойстваMETA_KEYWORDSСреди всех свойств, определенных для данного инфоблока, выбирается то, в котором содержатся ключевые слова.
    Устанавливать описание страницыSET_META_DESCRIPTION[Y|N] При отмеченной опции будет установлено описание страницы по заданному SEO-шаблону META DESCRIPTION (см. закладку "SEO" в инфоблоке) или из свойства. Становится активным поле:
    Установить описание страницы из свойстваMETA_DESCRIPTIONСреди всех свойств, определенных для данного инфоблока, выбирается то, в котором содержится описание.
    Устанавливать в заголовках ответа время модификации страницыSET_LAST_MODIFIED[Y|N] При отмеченной опции http-ответ сервера будет содержать время последнего изменения страницы (заголовок Last-Modified).
    Включать инфоблок в цепочку навигации INCLUDE_IBLOCK_INTO_CHAIN [Y|N] При отмеченной опции в цепочку навигации будет добавлено имя инфоблока.
    Включать раздел в цепочку навигации ADD_SECTIONS_CHAIN [Y|N] При отмеченной опции при переходе по разделам ифоблока в цепочку навигации будут добавлены названия или заголовки (если заданы в настройках SEO) разделов.
    Включать название элемента в цепочку навигации ADD_ELEMENT_CHAIN [Y|N] При отмеченной опции название или заголовок (если задан в настройках SEO) элемента будет добавлен в цепочку навигации.
    Формат показа даты ACTIVE_DATE_FORMAT Указывается формат показа даты. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
    Использовать дополнительное ограничение доступа USE_PERMISSIONS [Y|N] При отмеченной опции будет ограничен доступ к детальной информации элементов инфоблока. При отмеченной опции Станет активным поле Группы пользователей, имеющие доступ к детальной информации.
    Группы пользователей, имеющие доступ к детальной информацииGROUP_PERMISSIONSУказываются группы пользователей, имеющие доступ к детальной информации.
    будет ограничен доступ к детальной информации.
    Строгая проверка раздела для показа элемента STRICT_SECTION_CHECK [Y|N] При отмеченной опции будет выполняться строгая проверка принадлежности элемента к разделу. Таким образом, если при просмотре элемента в адресной строке указать неверный раздел, то будет выдана 404-я ошибка.
    Если опцию не отмечать, то нужный элемент будет показан в любом случае.
    Выводить дату элемента DISPLAY_DATE [Y|N] При отмеченной опции будут выведены даты элементов.
    Выводить название элемента DISPLAY_NAME [Y|N] При отмеченной опции для каждого элемента будет выведено его название.
    Выводить детальное изображение DISPLAY_PICTURE [Y|N] При отмеченной опции будут выведены детальные изображения для элемента, если они заданы.
    Выводить текст анонса DISPLAY_PREVIEW_TEXT [Y|N] При отмеченной опции будет выведен текст анонса для элементов, если он определен.
    Отображать панель соц. закладок USE_SHARE [Y|N] При отмеченной опции на странице детального просмотра новости будет отображена панель социальных закладок. Поля панели социальных закладок:
    Не раскрывать панель соц. закладок по умолчанию*SHARE_HIDE[Y|N] При отмеченной опции список социальных сетей будет свернут под общим значком.
    Шаблон компонента панели соц. закладок*SHARE_TEMPLATEУказывается имя шаблона, если используется несистемный шаблон.
    Используемые соц. закладки и сети*SHARE_HANDLERSЗадается перечень используемых соц. закладок и сетей.
    Логин для bit.ly*SHARE_SHORTEN_URL_LOGIN Логин для сервиса сокращений.
    Ключ для для bit.ly*SHARE_SHORTEN_URL_KEYПароль для сервиса сокращений.
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
    Учитывать права доступа CACHE_GROUPS [Y|N] При отмеченной опции будут учитываться права доступа при кешировании.
    Настройки постраничной навигации
    Шаблон постраничной навигации PAGER_TEMPLATE Указывается название шаблона постраничной навигации.
    Выводить над списком DISPLAY_TOP_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена вверху страницы, над списком.
    Выводить под списком DISPLAY_BOTTOM_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена внизу страницы, под списком.
    Название категорий PAGER_TITLE Задается название категорий, по которым происходит перемещение при детальном просмотре (например, страница, глава и др.).
    Показывать ссылку "Все" PAGER_SHOW_ALL [Y|N] При отмеченной опции будет отображена ссылка для просмотра новости целиком, без использования постраничной навигации. По умолчанию выключено.
    Включить обработку ссылокPAGER_BASE_LINK_ENABLE[Y|N] При отмеченной опции доступна обработка ссылок для постраничной навигации.Станут активны дополнительные поля. Дополнительные поля:
    Url для построения ссылок (по умолчанию - автоматически)PAGER_BASE_LINKЗадается адрес для построения ссылок. Если в параметре ничего не указывать, то адрес будет построен автоматически.
    Имя массива с переменными для построения ссылок в постраничной навигацииPAGER_PARAMS_NAMEЗадается имя переменной, в которой передается массив с переменными для построения ссылок компонентом постраничной навигации.
    Настройки 404 ошибки
    Устанавливать статус 404SET_STATUS_404[Y|N] Опция служит для включения обработки ошибки 404 в компоненте.
    Показ специальной страницыSHOW_404[Y|N] При отмеченной опции будет показана специальная страница Станет активным поле:
    Страница для показа (по умолчанию /404.php)FILE_404Задается адрес страницы, которая будет отображаться при возникновении ошибки 404.
    в случае возникновения ошибки 404, в противном случае - будет отображено специальное сообщение. Станет активным поле:
    Сообщение для показа (по умолчанию из компонента)MESSAGE_404Задается сообщение, которое будет показано в случае возникновения ошибки 404. Если ничего не указывать, то будет использоваться стандартное сообщение из компонента.

    Пользовательские комментарии

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

    Для этого нужно всего лишь авторизоваться на сайте

    Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

    Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
    © «Битрикс», 2001-2019, «1С-Битрикс», 2019
    Наверх