Skip to content

Enum: PurposeEnum

Recommended annotation purposes

URI: fix_orchestra:PurposeEnum

Enum URI: fix_orchestra:PurposeEnum

Permissible Values

Value Meaning Description
SYNOPSIS None Brief summary of the element, typically highlighting its key function or purp...
ELABORATION None Detailed explanation of the element, clarifying its usage, functionality, or ...
EXAMPLE None Sample or illustration demonstrating how the element is used in practice
DISPLAY None For UI when different from canonical name; may have multi-language displays
CAPTION None Descriptive label or title for the element, may be used for tables, figures, ...
TOOLTIP None Short message or hint that appears when hovering over the element, usually ex...
DEFINITION None Precise and formal explanation of the element, restricted to one sentence in ...

In Subsets

Aliases

  • purpose_enum

Identifier and Mapping Information

Schema Source

LinkML Source

name: PurposeEnum
description: Recommended annotation purposes
in_subset:
- repository_types
from_schema: https://w3id.org/lmodel/fix-orchestra
aliases:
- purpose_enum
exact_mappings:
- fixr:purpose_enum
rank: 1000
enum_uri: fix_orchestra:PurposeEnum
permissible_values:
  SYNOPSIS:
    text: SYNOPSIS
    description: Brief summary of the element, typically highlighting its key function
      or purpose, restricted to one paragraph for conciseness.
  ELABORATION:
    text: ELABORATION
    description: Detailed explanation of the element, clarifying its usage, functionality,
      or background.
  EXAMPLE:
    text: EXAMPLE
    description: Sample or illustration demonstrating how the element is used in practice.
  DISPLAY:
    text: DISPLAY
    description: For UI when different from canonical name; may have multi-language
      displays.
  CAPTION:
    text: CAPTION
    description: Descriptive label or title for the element, may be used for tables,
      figures, headings or brief annotations.
  TOOLTIP:
    text: TOOLTIP
    description: Short message or hint that appears when hovering over the element,
      usually explaining its function or use.
  DEFINITION:
    text: DEFINITION
    description: Precise and formal explanation of the element, restricted to one
      sentence in length to ensure brevity.