Документация InstantCMS - manual:ctypes:fields

Создание поля

Anonymous (anonymous@undisclosed.example.com) — 2020-11-23T07:31:27+00:00

Создание поля

Панель управления ⇒ Типы контента ⇒ Выбрать тип ⇒ Поля ⇒ Создать поле

Здесь описаны настройки для полей контента. Обратите внимание, что для системных полей (Заголовок, Дата, Автор, Описание) доступны не все перечисленные настройки.

Общие настройки

Системное имя

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

Название поля

Заголовок, который будет выводиться над полем в форме редактирования записи. Также может выводиться и при просмотре записи (или списка записей) – в зависимости от настроек в секции Положение заголовков.

Подсказка для поля

Аннотация, выводимая под полем в форме редактирования записи.

Тип поля

Здесь выбирается тип поля и опции, специфичные для данного типа. Подробнее о типах полей можно прочитать здесь

Группа

Поля можно группировать. Прикреплённые к одной группе поля будут при создании/редактировании записи выводиться в одном логическом блоке. Если разрешено в общих настройках типа контента, то сгруппированными поля будут выводиться и в самой записи.

Видимость поля

Здесь выбирается на каких страницах поле должно быть видимо – при просмотре списка, при просмотре записи или в обоих случаях. На видимость поля в форме редактирования записи эти настройки не влияют (см. секцию Доступ для изменения).

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

В теле записи - т.е. на странице записи в общем списке полей;
На позиции в специальном виджете - разместите на странице записи в нужном месте виджет «Поля контента» и настройте его. В опциях виджета появятся поля, выбранные для показа на этой позиции.

При включении опции Показывать в списке появится опция Для каких списков показывать, где можно выбрать тип списка для показа.

Опция Показывать в фильтре определяет можно ли будет фильтровать список записей по значению этого поля. Чтобы фильтр был видим на сайте он должен быть включен в настройках типа контента (см. секцию Просмотр списка)

Опция «Показывать только в контексте связи» позволяет выводить поле, только при добавлении записи к связываемому родительскому типу контента. В опции задаётся по какой связи выводить данное поле.

Положение заголовков

Опции определяют где показывать заголовок поля (слева или сверху относительно значения) при просмотре списка и записи. Заголовки можно отключить совсем.

Обтекание

В опциях задаётся тип обтекания для полей и ширина блока поля. Таким образом можно добиться гибкого расположения полей на странице. Тип обтекания «не участвовать в обтекании» очищает поток.

Формат поля

Опции в данной секции позволяют задать набор правил для содержимого поля. Данные введенные пользователем будут проверяться на соответствие этим правилам. Если какое-либо правило будет нарушено пользователь получит сообщение об ошибке и будет вынужден исправить значение.

Правило Уникальное значение означает что значение поля должно быть уникально среди всех записей контента данного типа.

Предустановленные значения

Позволяет задать значение по-умолчанию для поля.

Некоторые типы полей требуют чтобы это значение было введено в определенном формате.

Подробнее см. здесь

Значение из профиля пользователя

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

Доступ для чтения

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

Доступ для изменения

В данной секции можно выбрать каким группам пользователей можно показывать это поле при редактировании записи.

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

Показывать в фильтре

В данной секции можно выбрать каким группам пользователей показывать поле в фильтре.

Доступ для автора или владельца

В данной секции указывается доступность поля к редактированию и/или чтению поля для авторов или владельцев записей, если соответствующие доступы, описанные выше запрещают это. Например, группе «Модераторы» разрешено только чтение поля, но при этом для своих записей разрешено и изменение.

Типы полей профиля

Назад к Типам контента

Описание типов полей

Anonymous (anonymous@undisclosed.example.com) — 2025-03-18T20:57:59+00:00

Описание типов полей

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

Возраст

Поле предназначено для вывода времени, прошедшего с какой-либо даты. Например возраста человека или срока владения машиной. При редактировании поле выглядит как календарь с выбором даты. При просмотре - как строка, описывающая период времени, например 5 месяцев 12 дней 6 часов.

Опции

Название	Описание
Заголовок даты отсчета	Заголовок поля, который будет выводить в форме редактирования. Может отличаться от основного заголовка (выводимого при просмотре записи). Например для возраста это может быть «Дата рождения», для срока владения машиной - «Дата покупки»
Года	Какие интервалы времени показывать в результате. Например, если отмечены «Года» и «Месяцы» то вывод может выглядеть как `2 года 4 месяца`.
Месяцы
Дни
Часы
Минуты
Фильтр по диапазону	Какой интервал времени используется для фильтрации по этому полю
Считать от указанной даты	Дата, от которой вести отсчет времени. Если в поле ничего не указано - используется текущая дата.

Предустановленные значения

Не используются

Дата

Поле предназначено для вывода даты и времени чего-либо. При редактировании поле выглядит как календарь с выбором даты и, в случае если включена опция «Показывать время», два поля для указания времени с шагом в 5 минут. При просмотре - как строка, показывающая отформатированную дату согласно настроек сайта. Обратите внимание, в этом поле можно указать только даты, начиная с 2 января 1970 года.

Опции

Название	Описание
Показывать время	При редактировании или создании записи можно будет задать время с шагом в 5 минут. Время будет также выведено при просмотре.
Фильтр по диапазону	Если включено и показ фильтра разрешен, то список записей можно будет ограничить по диапазону дат - от и до.

Предустановленные значения

Не используются

Число

Поле предназначено для вывода чисел разного формата.

Опции

Название	Описание
Тип поля ввода	HTML5 тип тега <input>: text или number
Только положительные числа	В поле можно указывать только положительные числа.
Сохранять нулевое значение	Если включено, то ноль будет сохранён как ноль, иначе - пустота.
Количество разрядов целой части	Количество цифр слева от запятой.
Разделитель тысяч	Символ разделения тысяч чисел. Например, число 25000 при разделителе «пробел» будет выглядеть как 25 000.
Только целые числа	Если включено, то будут сохраняться только целые числа.
Разделитель дробной части	Символ разделения дробной части. Например, для числа Пи, значение может выглядеть как 3,14159 или 3.14159, в случае разделителя «запятая» или «точка» соответственно.
Количество разрядов дробной части	Количество чисел справа от запятой.
Обрезать дробные нули	Если включено, то число 7,8745000 будет выведено как 7,8745.
Фильтр по диапазону	Если включено и включен показ в фильтре, то поле будет выведено в фильтре двумя полями «от» и «до».
Выбор диапазона ползунком	Если включено, то диапазон можно будет задавать при помощи ползунка jqueryUI. Поле показывается, если есть записи со значениями поля, их больше одной и значения записей разные.
Показывать поля ввода вместе с ползунком	Если включено, то помимо ползунка, будет два поля ввода.
Шаг ползунка	Шаг сдвига ползунка. Укажите, исходя из опции «Количество разрядов целой части».
Префикс	Слово перед цифрами, как в форме, так и при выводе в записи.
Единица измерения	Укажите кратко единицу измерения.
Отделитель единиц измерения от числа	Символ или символы, разделяемые число и единицу измерения.

Предустановленные значения

Число в формате ваших настроек.

Строковое поле

Поле предназначено для вывода небольшого предложения, например, заголовка, какой-либо подписи и т.п.

Опции

Название	Описание
Минимальная длина	Минимальное количество символов в тексте
Максимальная длина	Максимальное количество символов в тексте
Показывать количество символов при вводе	Если включено, то снизу поля будет блок подсчета вводимых символов. При клике на количество, блок переключится на отсчет символов до достижения максимальной длины, если таковая задана в настройках.
Использовать маску для ввода	Если включено, то можно будет задать маску символов для ввода в этом поле.
Маска для ввода	Если включено, то в этом поле можно задать непосредственно маску. Базовые символы: 9 - цифра, a - буква, * - буквы и цифры. Если часть маски должна быть необязательной, её заключают в квадратные скобки []. Например, для номера телефона можно указать (999) 999[-99][-99], для водительского удостоверения 99 99 999999 и так далее. Также можно указывать количество символов после в фигурных скобках. Например, маска aa-9{4} говорит, что числовых символов должно ровно 4 (результат ВГ-7546), а маска aa-9{1,4} говорит, что числовых символов может быть от 1 до 4х. Если нужно условие «или», то это делается прямой чертой, например маска `(aaa\|999\|9AA)` подразумевает маски aaa или 999 или 9AA. Используется библиотека Inputmask, используйте документацию библиотеки для более тонкой настройки.
Вариант отображения в фильтре	Опция устанавливает как будет поле показано в фильтре (если оно используется там). «Строковое поле» просто покажет поле для ввода, «Выпадающий список с предустановленными значениями» покажет select с выбором существующих значений (предварительно нажмите под полем на ссылку «Заполнить предустановленные значения из имеющихся данных»), «Флаг заполненности поля» покажет чекбокс.
Обрезать текст при просмотре списка	Если поле показывается в каких-либо списках, то текст будет обрезан до установленного значения.
Автоссылка	Включение этой опции разбивает (по запятой) значение поля на отдельные слова и каждое делает ссылкой. Должен быть включен показ поля в фильтре.

Предустановленные значения

Любой текст.

Изображение

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

Опции

Название	Описание
Размер в списке	Какой размер изображения должен быть использован при просмотре списка или записи. Выбранные размеры должны быть также выбраны в поле «Создавать превью»
Размер в записи
Размер в записи при клике	Если выбран, то при клике на изображение откроется модальное окно, где будет показано изображение согласно размеров выбранного пресета. Пресет должен быть выбран в поле «Создавать превью».
Создавать превью-изображения	Загружаемое изображение будет автоматически сжиматься до размеров, указанных в перечисленных (отмеченных) пресетах. Рекомендуется всегда отмечать «Маленький» размер, поскольку он используется как превью при редактировании поля.
Разрешить добавление по ссылке	Если чекбокс поставлен, то рядом с кнопкой загрузки изображения будет кнопка добавления по ссылке. Движок скачает изображение и создаст превью-изображения так, как будто вы его загрузили со своего ПК

Предустановленные значения

Значения по-умолчанию могут быть заданы в формате:

Размер	Путь к файлу
micro	path/to/file1.jpg
small	path/to/file2.jpg
normal	path/to/file3.jpg
big	path/to/file4.jpg
original	path/to/file5.jpg

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

/var/www/my-site/upload,

то первый файл из примера выше должен лежать в

/var/www/my-site/upload/path/to/file1.jpg.

Могут быть перечислены как все пресеты одновременно (по одному на строке), так и любые их комбинации.

Набор изображений

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

Опции

Аналогичны полю «Изображение», за исключением того, что здесь добавлена опция «Выделять первое изображение в записи». Если она включена, то первое изображение из списка показывается большим размером, чем остальные.

Предустановленные значения

Не используются

Скрытое поле

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

Предустановленные значения

Любой текст или числа. Поле всегда хранит это значение, оно не может быть изменено пользователем, только программно.

Местоположение

Поле предназначено для создания гео-привязки по принципу Страна ⇒ Регион ⇒ Город. Одно поле может содержать только что-то одно: или страну, или регион или город.

Опции

Название	Описание
Тип местоположения	Выбирается тип: страна, регион или город.
Название для группировки	Эта опция позволяет объединить созданные поля этого типа в одно логическое. Обычно используется, если нужен последовательный выбор страна-регион-город. Как минимум должны быть созданы поля типа «страна» и «область».
Строка вывода значения поля	Этой строкой вы можете форматировать вывод. Например указав, `{country}, {city}`, где `country` и `city` системные имена полей. Полезно использовать, отключая для вывода остальные поля группировки, показывая нужные значения в этом поле. Если не указано - выводится значение текущего поля.

Если создается поле с типом местоположения город и не указывается название для группировки, то город выбирается во всплывающем окне со схемой страна-регион-город. Сохраняется при этом только город.

Предустановленные значения

ID выбранного типа местоположения.

Список

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

Опции

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

Предустановленные значения

Элементы списка в формате:

Элемент_1
Элемент_2
...
Элемент_N

В базе данных выбранное значение хранится в виде порядкового номера элемента (1, 2, …, N). Поэтому элементы можно переименовывать без потери данных.

Обратите внимание: нумерация элементов с единицы! Т.е. в базу данных, при выборе первого элемента списка попадёт число 1.

Есть возможность вручную задать порядковые номера элементам. Эти числа надо вписывать в начале строки, отделяя от значения символом вертикальной черты «|»:

id | элемент

Например:

1 | Килограмм
100 | Центнер
1000 | Тонна

Порядковые номера элементов важны, поскольку используются при создании наборов данных.

Ссылка

Позволяет запрашивать URL и выводить его в виде активной ссылки. При редактировании выглядит как текстовое поле, при просмотре - как активная ссылка.

Опции

Название	Описание
Ссылки через редирект	Если включено, переход по ссылке будет происходить через специальный скрипт. Таким образом для поисковых систем ссылка будет выглядеть как внутренняя, даже если ведет на внешний сайт.
Автоматически добавлять http://	Включите, если в этом поле предполагаются только внешние ссылки.

Предустановленные значения

Любой URL

Текст HTML

Поле предназначено для вывода отформатированного текста. При редактировании отображается как WYSIWYG-редактор, при просмотре - как гипертекст.

Опции

Название	Описание
Редактор HTML	Выбор одного из установленных WYSIWYG-редакторов/пресетов. Выбранный редактор будет использоваться при изменении поля.
Обрабатывать типографом	Если включено, введенный текст будет обрабатываться типографом (вырезаются лишние теги, кавычки заменяются на правильные и т.п.). Выключать эту опцию крайне не рекомендуется, т.к. злоумышленник в поле сможет передать любой текст, чем вызовет как минимум XSS уязвимость.
Пресет типографа	Указывается пресет типографа из списка доступных.
Обрабатывать специальные шаблоны	Используйте поля записи, вставляя их названия в фигурных скобках. Например, для типов контента: {title}, {category} и т.п. Можно использовать обработку значений.
Обрезать текст при просмотре списка	В списке записей текст обрежется до заданной длины, все html теги будут убраны
Участвует в полнотекстовом поиске	Если вы хотите, чтобы поле участвовало в поиске, поставьте этот чекбокс. Если сайт достаточно наполнен и записей много, то включение этой опции может занять продолжительное время.

Предустановленные значения

Любой HTML-код.

Флаг

Поле представляет из себя галочку, которая может быть снята или отмечена. При редактировании выглядит как чекбокс, при просмотре записи выводит 1 или 0. Может быть полезно для фильтрации контента по какому-либо признаку (например, «Выбор редакции»).

Предустановленные значения

0 или 1