Skip to main content

Item description plugin

When you enable item descriptions your users will be able to add additional information about items.

How it works

Description is a rich text that can be added to items. Currently simple Markdown is supported. It is displayed in item view and optionally in table view.

Usage

When to use

In most cases this plugin should be enabled. When item describes physical things, tasks, or concepts, additional context is often required.

When not to use

There are several cases where you don't want to enable description plugin. Writing description takes time. Disabling ability to add description conveys clear information to your users that its not required of them to do it.

You might not want to enable descriptions when:

  • items are of low value and its often too much work to write additional description.
  • it's collection of physical things where all relevant information can be stored in structured manner (using other plugins). One example is company car fleet. You don't necessary want to keep descriptions of each individual car.

Settings

Descriptions will be displayed on item view by default. You can make them visible on table view by in collection settings.

Alt Text

In the settings tab, you have the option to enable displaying descriptions in the table view.

Where it is displayed when enabled

Alt Text

On an item view

When enabled in settings, you can find descriptions on the right of table. You may need to scroll vertically to see it.

Hover over cell to see full description.

Alt Text

On a table view