lib/schema/moboFormAdditions.schema.yaml

Summary

Maintainability
Test Coverage
---
description: mobo form JSON Schema

properties:
  naming:
    type: string
    specific: domain
    description: |
      Provides naming conventions / guideline. Will appear on the form page itself.
    example:
      - |
        naming: 'lastname, firstname'

  items:
    description: |
      Declares all models and templates that the form uses and imports them through `$extend`.<br>
      To create multiple instance templates, add another items hierachy (see example).
    example:
      - |
        items:
        # Import a template and show it only in the page-view
        - $extend: /smw_template/SomeTemplate
          showForm: false

        # Include a single instance model
        - $extend: /model/SingleInstanceModel

        # Include a multiple instance model
        - items:
            $extend: /model/MultipleInstanceModel

  sf_forminput:
    type: object
    link: https://www.mediawiki.org/wiki/Extension:Semantic_Forms/Defining_forms#The_.23forminput_function
    specific: platform
    description: |
      Object, containing SemanticForms #forminput options
    example:
      - |
        smw_forminput:
          autocomplete on category: SomeCategory

  sf_forminfo:
    type: object
    link: https://www.mediawiki.org/wiki/Extension:Semantic_Forms/Defining_forms#.27info.27_tag
    specific: platform
    description: |
      Object, containing all SemanticForms info parameters.
    example:
      - |
        sf_forminfo:
          create title: Create a new location
          edit title: Edit a location

  sf_freetext:
    type: boolean
    default: true
    specific: platform
    description: |
      Decides whether the freetext textarea will be displayed below the form.
    example:
      - |
        sf_freetext: false

  sf_summary:
    type: boolean
    default: false
    specific: platform
    description: |
      Decides whether the summary field will be displayed below the form.
    example:
      - |
        sf_summary: false