Describo

Describo Profiles ​

Describo is driven by profiles. A profile is a set of instructions to the UI to describe how it should act. Put another way, Describo profiles define what your users can describe and how the application should look and work.

By default, Describo makes available all of Schema.org. Often times we don't want to expose all of this to our users so profiles are a way for a community to tell Describo exactly what users are allowed to describe.

Features of a profile:

  • Primitives to specify the type of data required: Text, TextArea, Boolean, Date, DateTime, Time, Number, Geo, URL, Select, SelectURL, SelectObject
    • Constraints to further limit the data input. Available on Text, TextArea and Number types
  • Layouts to specify property grouping and which properties to display.
  • Associations to specify inverse property associations
  • Resolve to specify how complex relational entities like Actions should display.
  • Localisation to translate entity classes in the User Interface.

Sharing your profile ​

Example profiles from specific domains can be seen in the domain profiles folder. If you'd like to publish your own profile for others to work with or use please submit a pull request to this repository. You must:

  • create a folder preferably named by your domain in the domain-profiles folder.
  • name your profiles in there in some sensible way.

Optionally, add a README to your folder - absolutely recommended but not an essential requirement.

A profile is a JSON description of what Describo should allow and how it should be presented to user.
1 / 4