Your schema is like a blueprint for the information you want to collect. You can change it to fit your needs by adding, removing, or renaming fields. Think of it as designing your own form: each field can be a text box, date, list of options, or even a set of steps

What You Can Add

Here are some common field types you can use:

1. Single Line of Text

  • Best for short answers (e.g., a title or name)
  • Example:
"type":"string"

2. Long Paragraph (Multiline)

  • Best for detailed explanations or descriptions.
  • Example:
"vtai-inputType": "multiline"

3. Date Field

  • Useful when you need to enter specific date and time.
  • Example:
"vtai-date": "DD/MM/YYYY HH:mm:ss A"

4. Dropdown Menu (Predefined Options)

  • Let users choose from a list of options instead of typing freely.
  • Example:
"vtai-options": ["advice", "warning", "information"]

5. Multiple Bullet Points (List of Items)

  • Useful for notes, tips, or extra information where you expect more than one entry.
  • Example
"type": "array"

How to Add a Field

Here’s how you can add different types of fiels inside the ‘Template Schema’ section.

1. Adding a Date Field 

"publish_date": {
  "type": "string",
  "vtai-date": "DD/MM/YYYY HH:mm:ss A",
  "$comment": "This field will store the publish date"
}

This will create a date field in the format 25/08/2025 03:45:00 PM

2. Adding a Dropdown Menu 

"category": {
  "vtai-options": [
    "guide",
    "tip",
    "warning"
  ],
  "$comment": "This property allows you to select a category"
}

This will let you pick one option from the list.

3. Adding a Long Paragraph 

"description": {
  "type": "string",
  "vtai-inputType": "multiline",
  "vtai-translate": true,
  "$comment": "This allows the user to write longer text"
}

This will create a multiline text box for writing paragraphs. Adding “vtai-translate”: true makes the text automatically translatable.

4. Adding Multiple Bullet Points 

"key_points": {
  "type": "array",
  "items": {
    "type": "string",
    "vtai-translate": true
  },
  "$comment": "A list of important notes"
}

This will allow you to add several bullet points, each as a separate item.

Example: A Custom Template

Here’s a full example combining different field types:

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "vtai-title": true,
      "$comment": "Main title of your project"
    },
    "publish_date": {
      "type": "string",
      "vtai-date": "DD/MM/YYYY HH:mm:ss A"
    },
    "category": {
      "vtai-options": ["guide", "tip", "warning"]
    },
    "description": {
      "type": "string",
      "vtai-inputType": "multiline",
      "vtai-translate": true
    },
    "key_points": {
      "type": "array",
      "items": {
        "type": "string",
        "vtai-translate": true
      }
    }
  },
  "required": ["title", "publish_date", "category"]
}

Tips for Customising

  1. Keep it simple – only add fields you really need.
  2. Use comments ($comment) – they don’t affect the schema, but they help explain what each field is for.
  3. Avoid trailing commas – JSON does not allow a comma after the last item in a list.
  4. Make key fields required – add them to the “required” section so they can’t be skipped.
  5. Use clear names – instead of field1 or extra_info, use names like publish_date, key_points, or description so it’s easier to understand.
  6. Test small changes – if you’re unsure, start with one new field, then add more later.

Go to the Template-Based Text Translation Project setup page to learn how to start translating with ready-made templates for faster, consistent results!