blueprints.yaml

name: Glossary
version: 0.2.0
description: Maintain a glossary of words and automatically add abbreviations to all pages via Markdown Extra.
icon: list
author:
  name: Nathan Parsons
  email: github@tantalum.blue
  url: https://github.com/n-parsons
keywords: grav, plugin, glossary, abbreviation, definitions
homepage: https://github.com/n-parsons/grav-plugin-glossary
bugs: https://github.com/n-parsons/grav-plugin-glossary/issues
license: MIT

form:
  validation: strict
  fields:
    enabled:
      type: toggle
      label: Plugin status
      highlight: 1
      default: 0
      options:
        1: PLUGIN_ADMIN.ENABLED
        0: PLUGIN_ADMIN.DISABLED
      validate:
        type: bool

    builtin_css:
      type: toggle
      label: Use builtin CSS
      highlight: 1
      default: 1
      options:
        1: PLUGIN_ADMIN.ENABLED
        0: PLUGIN_ADMIN.DISABLED
      validate:
        type: bool

    abbreviations:
      type: toggle
      label: Site-wide abbreviations
      help: Requires Markdown Extra to be enabled
      highlight: 1
      default: 1
      options:
        1: PLUGIN_ADMIN.ENABLED
        0: PLUGIN_ADMIN.DISABLED
      validate:
        type: bool

    glossary_section:
      type: section
      title: Glossary page
      text: This section allows you to configure the glossary page; you can add this to your site by creating a page with the `glossary_plugin` template. Search functionality depends on the SimpleSearch plugin.
      fields:
        show_search:
          type: toggle
          label: Search on glossary page
          help: Requires Simple Search
          highlight: 1
          default: 1
          options:
            1: PLUGIN_ADMIN.ENABLED
            0: PLUGIN_ADMIN.DISABLED
          validate:
            type: bool

        fa_search_icon:
          type: text
          label: Search icon
          placeholder: "eg. fas fa-search"

        fa_reset_icon:
          type: text
          label: Reset icon
          placeholder: "eg. fas fa-times"

        item_template:
          type: select
          label: Item template
          default: "dt_dd"
          options:
            "dt_dd": "Definition list (dl, dt, dd)"
            "details_summary": "Accordion (details, summary)"

    definitions_section:
      type: section
      title: Definitions and abbreviations
      text: Below is where you define your glossary terms and abbreviations; you can use Markdown in your definitions. The order here doesn't matter; they will be presented in alphabetical order in the glossary.
      fields:
        definitions:
          type: list
          style: vertical
          collapsed: true
          collapsible: true
          fields:
            .term:
              type: text
              label: Term
              validate:
                required: true
            .abbrev:
              type: text
              label: Abbreviation
            .definition_en:
              type: editor
              size: small
              label: Definition (EN)
              validate:
                required: true
            .definition_es:
              type: editor
              size: small
              label: Definition (ES)
            .definition_pt_br:
              type: editor
              size: small
              label: Definition (PT-BR)
            .definition_ar:
              type: editor
              size: small
              label: Definition (AR)