Добавление пользовательских свойств сайта

На сайты можно добавлять пользовательские свойства в виде пар "имя/значение". Эти свойства сохраняются на сайте и доступны для сценариев и компонентов на страницах сайта. Они позволяют параметризировать или настраивать сайт без изменения базовых сценариев и кода компонента.

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

Пользовательские свойства сайта добавляются с использованием панели настроек при редактировании сайта.

Откройте сайт для редактирования.
Нажмите на боковой панели и выберите Свойства сайта.
Нажмите Добавить.
Введите имя и значение пользовательского свойства сайта. Можно добавить до 50 пользовательских свойств сайта. В поле имени можно ввести не более 200 символов, а в поле значения — не более 2000 символов.
Чтобы удалить пару "имя/значение", нажмите символ X рядом с ней.
По завершении добавления или удаления пользовательских свойств сайта нажмите кнопку Фиксировать.

Примечание.:

Изменения не объединяются с существующими пользовательскими свойствами сайта. При внесении изменений в пользовательские свойства сайта все существующие пользовательские свойства сайта на базовом сайте перезаписываются.

После определения пользовательские свойства сайта можно использовать при создании сценариев для сайта и всех компонентов сайта, например, в нижнем колонтитуле или в поле "Дополнительная строка запроса" в компонентах, поддерживающих расширение SCSMacro, таких как список контента, или посредством маркеров в компонентах заголовка и абзаца.

Эти сценарии работают с SCSRenderAPI во время выполнения и проектирования. Кроме того, значения пользовательских свойств сайта доступны для кода макета и компонента в компиляторе шаблонов через интерфейс SCSCompileAPI. Этот API имеет новую функцию, аналогичную SCSRenderAPI, функцию getCustomSiteProperty, которая позволяет коду макета и компонента считывать значение пользовательского свойства раздела.

Например, предположим, что необходимо определить пользовательский макет раздела, который использует SCSRenderAPI для вызова и извлечения пользовательских свойств сайта для заголовка, имени и адреса электронной почты контактного лица. Представленный ниже сценарий позволяет создать строку HTML с использованием пользовательских свойств сайта, которые добавляются к DOM.

define([
    'jquery'
], function( $ ){
    'use strict';

    function SectionLayout( params ) {
    }
    SectionLayout.prototype = {
        render: function( parentObj ) {
            var html = '';

            try {
                html += '<div>';
                    html += '<h1>' + SCSRenderAPI.getCustomSiteProperty('SiteGreeting') + '</h1>;
                    html += '<div>For more information, contact <a href="mailto:' + SCSRenderAPI.getCustomSiteProperty('ContactEmail')
                        '"> + SCSRenderAPI.getCustomSiteProperty('ContactName') + '</a></div>';
                html += '</div>';
                $(parentObj).append( html );
            } catch( e ) {
                console.error( e );
            }
        },
    };

Пользовательские свойства сохраняются при создании шаблона на основе сайта с добавленными пользовательскими свойствами сайта и при создании сайта на основе шаблона с пользовательскими свойствами сайта.