Руководство по стилю шаблона

Это руководство по стилю было подготовлено, чтобы помочь вам принять решение о том, как подготовить шаблоны для Галереи шаблонов сообщества . Это руководство по стилю основано на принципах Google Material Design . Проще говоря, это:

  • Будьте лаконичны
  • Пишите просто и прямо
  • Обращайтесь к пользователям четко
  • Сообщите важные детали
  • Пишите для всех уровней чтения
  • Будь человеком: пиши для людей, а не для роботов

Следуйте этим рекомендациям, чтобы убедиться, что все шаблоны имеют одинаковый внешний вид, а также помочь пользователям понять, как использовать ваш шаблон.

Информация

Эти рекомендации относятся к элементам, которые находятся на вкладке « Информация » редактора шаблонов.

Имя

Имя шаблона отображается пользователям Диспетчера тегов в пользовательском интерфейсе Диспетчера тегов и в галерее шаблонов сообщества. Он отображается в верхней части страницы сведений о шаблоне и появляется при отображении шаблонов.

  • Используйте название вашей компании/организации и функциональное имя шаблона: Название организации Имя шаблона .
  • Используйте регистр заголовка.
  • Используйте термины, описывающие функциональность.
  • Избегайте использования термина «Официальный» в именах шаблонов, если вы не уполномочены на это соответствующей организацией.

Примеры: тег измерения конверсии MyCompany, переменная идентификатора кампании MyCompany .

Описание

Описание шаблона — это описание шаблона, которое отображается на страницах сведений в виде краткого описания функций шаблона.

  • Используйте четкие и краткие предложения, чтобы описать, что делает шаблон.
  • Четко укажите, какую пользу ваш шаблон приносит пользователю. Например: «Шаблон Example.com Audience Builder может помочь вам создать новые списки аудитории из посетителей веб-сайта».
  • Избегайте жаргона.
  • Включите ссылки для получения дополнительной информации, документации и поддержки.

Значок

Значок вашего шаблона отображается в виде миниатюры, когда он указан в диспетчере тегов и в галерее шаблонов сообщества.

  • Используйте PNG, JPEG или GIF в качестве формата изображения.
  • Изображение должно быть квадратным, размером не менее 48 на 48 пикселей и не более 96 на 96 пикселей.
  • Размер файла должен быть меньше 50 килобайт.
  • Избегайте использования официальных логотипов компаний, если только вы не уполномочены на это соответствующей организацией.
  • Поля
  • Используйте вкладку «Поля» редактора шаблонов, чтобы добавить элементы формы, такие как ввод текста, флажки и т. д.

Поля

Эти рекомендации по стилю относятся к вкладке « Поля » редактора шаблонов.

Имя параметра

Это имя поля, которое отображается в редакторе шаблонов, а не для пользователя. Имена должны быть описательными для типа используемых данных. Отформатируйте имена параметров как lowerCamelCase . Примеры: userName, customerID, shoppingCartValue .

Метки полей

Метки полей включают поля отображаемого имени, текст флажка и связанные элементы.

  • Используйте регистр предложения.
  • Короче лучше.
  • Будьте описательными.
  • Используйте общие слова.

Текст справки

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

  • Используйте регистр предложения.
  • Будьте кратки, но будьте человечны. Можно использовать сокращения и писать от 2-го лица (вы).
  • Поддерживаемые типы полей
  • Разрешено базовое форматирование HTML. Примеры: <strong> , <em> .

Поддерживаемые типы полей

Тип
 Описание
Ввод текста Ввод текста. Значением параметра шаблона этого типа будет строка, которая может ссылаться на переменные. Виджет ввода текста, отображаемый в пользовательском интерфейсе Диспетчера тегов, может быть либо однострочным текстовым полем, либо многострочным вводом.
Выпадающее меню Выпадающее меню, в котором можно было выбрать только один элемент в качестве значения параметра шаблона. Перечислите элементы в алфавитном порядке, если нет веской причины поступить иначе.
Флажок Ввод флажка. Значение параметра шаблона этого типа будет логическим: true для проверенного, false для непроверенного.
Переключатель Радио вход. Параметр шаблона этого типа представляет собой список вариантов в пользовательском интерфейсе Диспетчера тегов, и пользователю разрешено выбрать только один из вариантов в качестве значения параметра шаблона.
Простая таблица Простой ввод таблицы. Каждую ячейку в таблице можно редактировать на месте, и каждая ячейка может быть только двух типов: текстовый ввод или выпадающее меню. Значение параметра шаблона этого типа представляет собой массив объектов: каждый объект кодирует строку, каждый ключ в объекте должен быть одним из имен столбцов, а каждое значение в объекте является значением соответствующей ячейки.