Config


The possible types of configuration files (this allows main files to be different from internationalization files).

root anyOf item 0
Type: object

A root configuration file that defines languages that have their own configuration files.

root anyOf item 0 languages
Type: object

A map of the languages supported to filenames, a structure that separates each language into a separate Tribble file.

Each additional property must conform to the following schema

root anyOf item 0 languages additionalProperties
Type: string
root anyOf item 1
Type: object

A configuration file for a single language.

root anyOf item 1 input_err_msg
Type: string Default: "This field is required, please enter a value."

The error message when a user doesn't fill out a mandatory field. This is allowed to enable i18n at an arbitrary scale. This field does not support Markdown.

root anyOf item 1 workflows
Type: object

All the workflow in this Tribble instance. Each workflow is a separate contribution experience, and multiple workflows are generally best suited for things like separate products.

Each additional property must conform to the following schema

root anyOf item 1 workflows Workflow
Type: object

The components of a workflow.

root anyOf item 1 workflows additionalProperties endpoints
Type: object

The endpoints that the user can exit the process from.

Each additional property must conform to the following schema

root anyOf item 1 workflows additionalProperties endpoints Endpoint
Type: object

The possible endpoint types (endpoints are sections that allow the user to exit the contribution process).

root anyOf item 1 workflows additionalProperties endpoints additionalProperties anyOf item 0
Type: object

A report endpoint, which gives the user a formatted report in Markdown to send to the project.

root anyOf item 1 workflows additionalProperties endpoints additionalProperties anyOf item 0 dest_text
Type: string

The text of a button for sending teh user to wherever they'll report the issue. This does not support Markdown.

root anyOf item 1 workflows additionalProperties endpoints additionalProperties anyOf item 0 dest_url
Type: string

A URL to send the user to so that they can report the issue. If the platform supports interpolating text to be sent into the URL, you can do so by interpolating %s into this field.

root anyOf item 1 workflows additionalProperties endpoints additionalProperties anyOf item 0 preamble
Type: string

The preamble text to display before the actual formatted report. Markdown can be used here.

root anyOf item 1 workflows additionalProperties endpoints additionalProperties anyOf item 0 text
Type: string

The formatted report. The UI will not allow the user to edit this, but will provide a copy button. Interpolation of form values is allowed here with ${form_id} syntax. This should be written in the appropriate templating language for your issue reporting system (e.g. Markdown for GitHub issues), and will be displayed as a raw, pre-formatted string.
root anyOf item 1 workflows additionalProperties endpoints additionalProperties anyOf item 1
Type: string

An instructional endpoint, which tells the user to do something. This supports Markdown.

root anyOf item 1 workflows additionalProperties index
Type: string

The section to start on, which must be a valid key in the sections map.

root anyOf item 1 workflows additionalProperties sections
Type: object

The sections that the page can make use of.

Each additional property must conform to the following schema

root anyOf item 1 workflows additionalProperties sections additionalProperties
Type: array

Each item of this array must be:

root anyOf item 1 workflows additionalProperties sections additionalProperties SectionElem
Type: object

The possible parts of a section.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 0
Type: string

Simple text to be displayed to the user. Markdown is supported here, and this will be rendered to HTML to be interpolated into the page.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 1
Type: object

A progression option for moving to another section.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 1 tags
Type: array of string

Any tags that should be accumulated as a result of proceeding through this route.

Each item of this array must be:

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 1 tags tags items
Type: string

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 1 text
Type: string

The text to display to the user. This does not support Markdown, as it goes inside an HTML button.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2

A form input that the user can fill out. This must have an associated ID, because its value can be referenced later in an endpoint.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf InputSectionElem
Type: object

The properties of an input element. This needs to be passed around, so it's broken out of the SectionElem input.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0

Simple text.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 0
Type: object

A boolean input.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 1
Type: object

A multiline text input.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 2
Type: object

A color picker (only in supported browsers).
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 3
Type: object

A simple text element (default).
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 4
Type: object

A date input.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 5
Type: object

A datetime input, with no time offset (by UTC has been deprecated at the standard-level).
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 6
Type: object

An email input.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 7
Type: object

A month input.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 8
Type: object

A numerical input.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 8 max
Type: integer or null Default: null

The largest number the user can input.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 8 min
Type: integer or null Default: null

The smallest number the user can input.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 9
Type: object

A password input (characters are obfuscated).
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 10
Type: object

A range slider.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 11
Type: object

A telephone number input.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 12
Type: object

A time picker.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 13
Type: object

A URL input.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 0 oneOf item 14
Type: object

A week input.
root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 1
Type: object

A select element that provides a dropdown for the user to select a single option.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 1 can_select_multiple
Type: boolean Default: false

Whether or not the user can select multiple options.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 1 options
Type: array

The options that the user can select from.

Each item of this array must be:

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 anyOf item 1 options SelectOption
Type: object

The properties for an option for a select element. The text of this MUST NOT contain commas, otherwise all sorts of runtime errors WILL occur!

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 default
Type: string or null

The default value for the input. If the input is optional, this will be the value used for interpolation. If the input is not optional, this will be the default, which means it will be left as this if the user doesn't fill it in. If a value should be provided, you should make it mandatory and set a default, as optional fields should be assumed to potentially not contain any value (even though they always will if a default value is provided).

If the input is a Select, this must correspond to an entry in options.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 id
Type: string

The input's ID, which can be used to reference its value later for interpolation in a formatted report.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 label
Type: string

The label for the input. This does not support Markdown.

root anyOf item 1 workflows additionalProperties sections additionalProperties additionalProperties items anyOf item 2 allOf item 0 optional
Type: boolean Default: false

Whether or not the input is optional.

root anyOf item 1 workflows additionalProperties title
Type: string

The title of the page dedicated to this workflow (appears in tabs).