Spacialist Documentation
Home
User
Developer
GitHub
Home
User
Developer
GitHub
  • User

    • Overview
    • Dictionary (Thesaurus)
    • User And Role Management
    • Data Model
      • Entity Type
      • Attribute
      • Attribute Types
    • Entity
    • Collaboration
    • Bibliography
    • Spatial Data
    • Data Importer
    • Data Analysis Tool
  • Developer

    • Developer
    • Coding Structure
    • Plugin
    • Classes

      • Entity Type
    • Commands

      • Export Entity Types (Data Model)
      • Refresh Testing

Attribute Types

The Spacialist provides a big variety of different attribute types that can be used inside your Data Model. Named versions of those Attribute Types are used to populate the Entity Types. There are additional System Attributes which don't need to be created but can be used right away.

Boolean
(yes / no)
DateNumberSetsReferenceListsTextGeography
CheckboxDateSi-UnitEntityURLListTextboxWKT
DateRangePercentageEntity (Multiple Choice)IconclassTableTextfield
Time PeriodFloatSingle Choice DropdownRISMRich-Text
Time Period And EpochIntMultiple Choice Dropdown
Dimension

In the next section we'll introduce all available attribute types, what they are used for and how the import data has to be formatted. Note the following special symbols that may be used in the formatting, which will not be typed and have only semantic meaning.

  • ... - is a placeholder for various content
  • [...] - Stand for optional syntax, the squared brackets should be ignored
  • [... ⟳] - Stands for an expression that can be repeated indefinetly

Checkbox

Image of checkbox input

Used for single checkbox to represent the binary values trueand false.

Import Format

When importing only truthy values will be considered. When cells are empty those are considered as false.

The values that are considered true are:

  • x
  • t or true
  • w or wahr
  • numeric values > 0

Date

Image of the date input

Represents a single date attribute, that is rendered with a default calender input field in the application.

Import Format

YYYY-MM-DD e.g. 2024-10-30

It only accepts dates in the format

Date Range

Image of the date range input

Represents a date range between two dates.

Import Format

YYYY-MM-DD;YYYY-MM-DD e.g. 2024-10-25;2024-10-30

The range must have a START and END date with the format YYY-MM-DDseparated by a semicolon. The start date must be earlier than the end date: START;END

Dimension

Image of the dimensions input

This attribute represents the extends of a three-dimensional object, with width, height, depth and an arbitraray unit (Note: that this is not powered by the SI-Unit system).

Import Format

W;H;D;UNIT e.g 2.5;51.2;210.3;cm

The values W,H and D must be numeric values. And the UNIT value may be any string. Those values need to be separated by a semicolon ;.

Entity

Image of the entity single input

A dropdown for selecting a single entity. Can be limited to a specific entity type.

Import Format

ENTITY_NAME

The entity name must match the entity (case-sensitive).

Entity (Multiple Choice)

Image of the entity multiple input

A dropdown for selecting multiple entites. Can be limited to a specific type.

Import Format

ENTITY_1;ENTITY_2

The entities to import. Must match the entity name (case-sensitive).

Import Format

START;END;EPOCH_CONCEPT e.g. -100;30;antiquity

A start year and a end year in the gregorian calendar as integer values. Optional can be an epoch thesaurus concept. If the year is a negative number, it refers to the time before christ.

Iconclass

Image of the iconclass input

Can be used to collect data as Iconclass objects, as specified at https://iconclass.org/.

Import Format

ICONCLASS_STRING e.g. 22A311

Any iconclass string as defined at https://iconclass.org/.

List

Image of list input

Field for a list of text values.

Import Format

TEXT[;TEXT ⟳]

An arbitrary number of items separated by a semicolon.

Multiple Choice Dropdown

Image of the dropdown multiple input

A dropdown that allows selelcting from a list of concepts from the thesaurus.

Import Format

CONCEPT_1;CONCEPT_2;CONCEPT_3;[...] e.g. Red;Green;Blue

A list of concepts that is separated with a semicolon ;. For more infos see Dropdown Single

Numeric Input (Floating Point)

Image of the double input

Represents a floating point number.

Import Format

N

Must be any valid floating point number representation using a . as a decimal separator. 234, -18, 2.3, 1.2e3 or 7E-10.

Numeric Input (Integer)

Image of the integer input

Field for integer values

Import Format

INT_VAL e.g. 5

Can be any integer number x that is in the valid range of PHP_INT_MIN < x <PHP_INT_MAX.

Percentage

Image of percentage input

Field that allows

Import Format

X e.g. 33

X is an integer value in the form of: 0 <= X <= 100.

Richtext

This creates a textarea with formatted text, allowing various text decorations that are specified in the very simple Markdown Syntax.

Image of rich-text input

Spacialist offers a convenient editor to edit these text with tools most know from Softwares like Word.

Image of rich-text input

The unformatted Markdown text looks like this.

Image of rich-text input

Import Format

X e.g.

# Heading

Some Text with **bold** or _italic_ or ~struck out~\

X is a text string that may contain markdown syntax.

RISM

Image of rism input

Id to a musical peace inside the RISM catalog.

Import Format

X e.g. 600146721

X needs to be a positive integer value.

Serial

Image of serial input

The serial attribute counts all entities that have this attribute attached and displays a distinct index number for every one of them. To use the counter you must use the %dmarker during the creation of this attribute. This allows to create meaningful tags e.g. find_#%d which results in find_#5. The order of the enumeration is the time the entity was created. To ensure always nglyphs in the counter (e.g. #003) you may use the syntax %03d.

Warning

This serial is not a persistent id, as it may change. When some entities are created at the same time or an entity type receives or loses this attribute, the enumeration will change!

Import Format

Caution

Serial values cannot be imported

Si Unit

Image of si-unit input

A numeric input associated with a si unit. The si type (e.g. mass or temperature) is fixed when creating the attribute. The si 'prefix' (e.g. kg, g, t) can be changed by the user.

Import Format

VALUE;UNIT e.g. 80;kg

VALUE must be a numeric value. UNIT must be a supported unit.

Single Choice Dropdown

Image of the dropdown single input

A dropdown that is populated by thesaurus concepts and allows the selection of exactly one item.

Import Format

CONCEPT_NAME e.g. Red

The concept name must match excactly the concept that you want to import. The concept can be in any language.

Textbox

Image of stringfield input

A textarea for longer, unformatted texts.

Import Format

X e.g. This is a note

X is any string.

Textfield

Image of textbox input

A textbox for short, unformatted texts.

Import Format

X e.g. This is a note

X is any string.

Time Period

Image of timeperiod input

A span of two years (as integers).

Import Format

START;END e.g. -100;30

A start year and a end year in the gregorian calendar as integer values. If the year is a negative number, it refers to the time before christ. The start year must be before the end year.

Time Period and Epoch

Image of the epoch input

Has two parts. A time span field and a thesaurus dropdown field to specify the epoch.

URL

Image of url input

A textfield that contains a link. The field can be clicked to visit that website in a new tab.

Import Format

X e.g. https://uni-tuebingen.de

X is any string.

UserList

Image of user-list input

A list of users.

Import Format

USER_1;USER_2 e.g. john;admin

USER must be an existing nickname of a user.

WKT (Geography)

Image of the geography input

Adds a geographical attribute to the entity. Currently they cannot be linked on the main map. Each entity has a single field for geo referencing internally.

Import Format

WKT_STRING e.g. POINT(1 1)

Any valid WKT string, a good overview of these strings can be found on Wikipedia.

Edit this page
Last Updated:: 6/3/25, 2:33 PM
Contributors: Severino, Sev
Prev
Attribute