Чертежи — это метаданные информации о ресурсе (источнике информации). Он служит двум целям —
- Во-первых, это сам идентификатор ресурса.
- Второе касается форм.
Эта полная информация сохраняется в файле blueprints.yaml, который присутствует в каждом плагине или теме.
Идентичность ресурса
В blueprints.yaml идентичность файла определяется для каждой темы и плагина. Ресурс не будет добавлен в репозиторий Grav, пока чертежи не будут отформатированы и скомпилированы без ошибок.
Пример чертежей
name: plugin name version: 0.6.0 description: Adds an advanced plugin to manage your site icon: empire author: name: Team Grav email: devs@getGrav.org url: http://getGrav.org homepage: https://github.com/getGrav/Grav-plugin-assets keywords: assets, plugin, manager, panel bugs: https://github.com/getGrav/Grav-plugin-assets/issues readme: https://github.com/getGrav/Grav-plugin-assets/blob/develop/README.md license: MIT dependencies: - form - email - login form: validation: loose fields: Basics: type: section title: Basics underline: false enabled: type: hidden label: Plugin status highlight: 1 default: 0 options: 1: Enabled 0: Disabled validate: type: bool
Следующие несколько свойств являются необязательными, и некоторые из них используются для предоставления вашей личности и ресурса.
| Sr.No. | Свойства и описание |
|---|---|
| 1 |
название* Упомяните название ресурса. |
| 2 |
версия* Определяет версию ресурса. |
| 3 |
описание* Дает краткое описание о ресурсе. Оно не должно превышать более 200 символов. |
| 4 |
значок* Определяет библиотеку иконок для разработки новой темы или плагина. |
| 5 |
имя автора* Определяет имя разработчика. |
| 6 |
author.email (необязательно) Определяет адрес электронной почты разработчика. |
| 7 |
author.url (необязательно) Определяет домашнюю страницу URL разработчика. |
| 8 |
домашняя страница (необязательно) Определяет выделенный URL для домашней страницы вашего ресурса. |
| 9 |
документы (необязательно) Указывает ссылку на документацию, которую вы написали для своего ресурса. |
| 10 |
демо (необязательно) Определяет ссылку на демонстрационный ресурс. |
| 11 |
руководство (необязательно) Определяет ссылку, как руководство или учебные пособия для вашего ресурса. |
| 12 |
ключевые слова (необязательно) Указывает список ключевых слов, связанных с вашим ресурсом. |
| 13 |
ошибки (необязательно) Указывает URL-адрес, по которому можно сообщать о проблемах или ошибках. |
| 14 |
лицензия (необязательно) Указывает вашу лицензию на ресурс, т.е. MIT, GPL и т. Д. |
| 15 |
зависимости (необязательно) Указывает имя зависимостей, которые требуются для плагинов или тем. |
название*
Упомяните название ресурса.
версия*
Определяет версию ресурса.
описание*
Дает краткое описание о ресурсе. Оно не должно превышать более 200 символов.
значок*
Определяет библиотеку иконок для разработки новой темы или плагина.
имя автора*
Определяет имя разработчика.
author.email (необязательно)
Определяет адрес электронной почты разработчика.
author.url (необязательно)
Определяет домашнюю страницу URL разработчика.
домашняя страница (необязательно)
Определяет выделенный URL для домашней страницы вашего ресурса.
документы (необязательно)
Указывает ссылку на документацию, которую вы написали для своего ресурса.
демо (необязательно)
Определяет ссылку на демонстрационный ресурс.
руководство (необязательно)
Определяет ссылку, как руководство или учебные пособия для вашего ресурса.
ключевые слова (необязательно)
Указывает список ключевых слов, связанных с вашим ресурсом.
ошибки (необязательно)
Указывает URL-адрес, по которому можно сообщать о проблемах или ошибках.
лицензия (необязательно)
Указывает вашу лицензию на ресурс, т.е. MIT, GPL и т. Д.
зависимости (необязательно)
Указывает имя зависимостей, которые требуются для плагинов или тем.
Ниже приведен пример схемы плагина входа в систему:
name: Login version: 0.3.3 description: Enables user authentication and login screen. icon: sign-in author: name: Team Grav email: devs@getGrav.org url: http://getGrav.org keywords: admin, plugin, login homepage: https://github.com/getGrav/Grav-plugin-login keywords: login, authentication, admin, security bugs: https://github.com/Getgrav/Grav-plugin-login/issues license: MIT
формы
Вы можете заполнить файл blueprints.yaml формами, если хотите, чтобы темы или плагины имели параметры, непосредственно настраиваемые из интерфейса администратора. Часть этого ресурса может быть настроена через плагин Admin , который определяется метаданными Forms .
Ниже приведен пример файла Archives Плагин Archives.yaml.
enabled: true built_in_css: true date_display_format: 'F Y' show_count: true limit: 12 order: by: date dir: desc filter_combinator: and filters: category: blog
Это настройки плагина по умолчанию. Чтобы настроить их без использования плагина Admin, пользователь должен скопировать этот файл в папку /user/config/plugins/archives.yaml и внести изменения. Вы можете правильно предоставить файл archives.yaml ; Вы можете изменить настройки в интерфейсе администратора от пользователей.
После сохранения изменений они будут автоматически записаны в <your_folder_name> /user/config/plugins/archives.yaml .
Файл blueprint.yaml плагина Archives содержит структуру, показанную ниже:
name: Archives version: 1.3.0 description: The **Archives** plugin creates links for pages grouped by month/year icon: university author: name: Team Grav email: devs@getGrav.org url: http://getGrav.org homepage: https://github.com/getGrav/Grav-plugin-archives demo: http://demo.getGrav.org/blog-skeleton keywords: archives, plugin, blog, month, year, date, navigation, history bugs: https://github.com/getGrav/Grav-plugin-archives/issues license: MIT form: validation: strict fields: enabled: type: toggle label: Plugin status highlight: 1 default: 1 options: 1: Enabled 0: Disabled validate: type: bool date_display_format: type: select size: medium classes: fancy label: Date Format default: 'jS M Y' options: 'F jS Y': "January 1st 2014" 'l jS of F': "Monday 1st of January" 'D, m M Y': "Mon, 01 Jan 2014" 'd-m-y': "01-01-14" 'jS M Y': "10th Feb 2014" limit: type: text size: x-small label: Count Limit validate: type: number min: 1 order.dir: type: toggle label: Order Direction highlight: asc default: desc options: asc: Ascending desc: Descending
Ниже приведены элементы формы, присутствующие в archive.yaml .
тумблер
enabled: type: toggle label: Plugin status highlight: 1 default: 1 options: 1: Enabled 0: Disabled validate: type: bool
Выбрать
date_display_format: type: select size: medium classes: fancy label: Date Format default: 'jS M Y' options: 'F jS Y': "January 1st 2014" 'l jS of F': "Monday 1st of January" 'D, m M Y': "Mon, 01 Jan 2014" 'd-m-y': "01-01-14" 'jS M Y': "10th Feb 2014"
Текст
limit: type: text size: x-small label: Count Limit validate: type: number min: 1
Корневой элемент Enabled, date_display_format и limit являются опциями. Поле, присутствующее в этом корневом элементе, определяет тип, размер, метку, значение по умолчанию и параметры. В зависимости от типа поля другие поля могут меняться; например, поле выбора требует список опций.
Направление заказа
order.dir: type: toggle label: Order Direction highlight: asc default: desc options: asc: Ascending desc: Descending
Это поле состоит из вложенных опций. Существует множество типов полей, которые можно использовать в плагинах / admin / themes / Grav / templates / forms / fields . Как мы видим в файле archive.yaml , проверка формы установлена в строгом режиме. Если проверка установлена как строгая, то для всех параметров необходимо добавить форму чертежей, в противном случае при сохранении появится сообщение об ошибке. Форма form.validation может быть свободна, если вы хотите настроить только два поля для интерфейса администратора.
Следующая таблица дает краткое объяснение полей, относящихся к вышеуказанным элементам формы.
| Sr.No. | Поле и описание |
|---|---|
| 1 |
Тип Указывает тип поля. |
| 2 |
Размер Определяет размер поля. |
| 3 |
этикетка Определяет метку для поля. |
| 4 |
утверждать Он проверяет тип поля и минимальную длину, введенную в поле. |
| 5 |
По умолчанию Устанавливает поля по умолчанию. |
| 6 |
Опции Определяет список опций. |
| 7 |
Классы Определяет класс для поля. |
Тип
Указывает тип поля.
Размер
Определяет размер поля.
этикетка
Определяет метку для поля.
утверждать
Он проверяет тип поля и минимальную длину, введенную в поле.
По умолчанию
Устанавливает поля по умолчанию.
Опции
Определяет список опций.
Классы
Определяет класс для поля.
Поля формы доступны в админке
Существует множество встроенных полей формы, которые используются плагинами и темами или могут создавать свои собственные поля формы. В следующей таблице перечислены доступные поля формы.
флажок
Отображает один флажок.
Флажки
Отображает список флажков.
Дата
Содержит поле даты.
Datetime
Содержит поле даты и времени.
Эл. адрес
Содержит поле адреса электронной почты с проверкой.
пароль
Содержит поле пароля, которое отображается в точечном формате.
скрытый
Содержит скрытое поле ввода.
Радио
Позволяет выбрать только один вариант из списка.
Выбрать
Это поле содержит несколько вариантов.
распорка
Добавляет заголовок, текст или горизонтальную линию в форму.
Текст
Содержит обычное текстовое поле.
Textarea
Содержит многострочные текстовые вводы.
массив
Добавляет несколько строк значения ключа.
игнорировать
Неиспользуемые поля удаляются.
Колонны
Делит форму на несколько столбцов.
колонка
Отображает один столбец.
Формат даты
Устанавливает формат даты и времени.
дисплей
Отображает текстовое значение без какого-либо входного значения.
Frontmatter
Страница отображается в необработанном формате.
Список
Отображение списка предметов без ключа.
уценка
Отображает редактор уценки.
страницы
Отображает список страниц.
Раздел
Страница настроек разделена на разделы, и каждый раздел имеет заголовок.
Selectize
Используется для выбора ящиков.
Вкладки
Настройки разделены на список вкладок.
табуляция
Поле вкладок используется для предоставления вкладки.
таксономия
Это предварительно настроенный для выбора таксономии.
тумблер
Он представляет собой эффект переключения, который определяет тип входа или выключения.