From 75c6ae5915de7432d7bb768f14a9ff9bdec9dfb2 Mon Sep 17 00:00:00 2001 From: Johannes Nussbaum <39048939+jnussbaum@users.noreply.github.com> Date: Wed, 10 Aug 2022 14:17:37 +0200 Subject: [PATCH] docs: sort entries alphabetically (DEV-1184) (#212) --- docs/dsp-tools-create-ontologies.md | 308 ++++++++++++++-------------- 1 file changed, 153 insertions(+), 155 deletions(-) diff --git a/docs/dsp-tools-create-ontologies.md b/docs/dsp-tools-create-ontologies.md index 65873a670..4ab38509e 100644 --- a/docs/dsp-tools-create-ontologies.md +++ b/docs/dsp-tools-create-ontologies.md @@ -239,135 +239,71 @@ These three are related as follows: The following data types are allowed: -- `TextValue` +- `BooleanValue` - `ColorValue` - `DateValue` -- `TimeValue` - `DecimalValue` - `GeonameValue` -- `IntValue` -- `BooleanValue` -- `UriValue` - `IntervalValue` +- `IntValue` - `ListValue` +- `TextValue` +- `TimeValue` +- `UriValue` - in case of a link property: any resource class +#### BooleanValue -#### TextValue - -`"object": "TextValue"` - -Represents a text that may contain standoff markup. - -*gui_elements / gui_attributes*: - -- `SimpleText`: A GUI element for _TextValue_. A simple text entry box (one line only). The attributes are: - - _gui_attributes_: - - `maxlength=integer` (optional): maximal length (number of characters accepted) - - `size=integer` (optional): size (width) of widget -- `Textarea`: A GUI element for _TextValue_. Presents a multiline text entry box. The optional attributes are: - - _gui_attributes_: - - `cols=integer` (optional): number of columns of the textarea - - `rows=integer` (optional): number of rows of the textarea - - `width=percent` (optional): width of the textarea on screen - - `wrap=soft|hard` (optional): wrapping of text -- `Richtext`: A GUI element for _TextValue_. Provides a richtext editor. - - _gui_attributes_: No attributes - -*Example:* - -```json -{ - "name": "hasPictureTitle", - "super": [ - "hasValue" - ], - "object": "TextValue", - "labels": { - "en": "Title" - }, - "gui_element": "SimpleText", - "gui_attributes": { - "maxlength": 255, - "size": 80 - } -} -``` - -#### IntValue - -`"object": "IntValue"` +`"object": "BooleanValue"` -Represents an integer value. +Represents a Boolean ("true" or "false). *gui-elements / gui_attributes*: -- `SimpleText`: A GUI element for _TextValue_. A simple text entry box (one line only). The attributes - "maxlength=integer" and "size=integer" are optional. - - _gui_attributes_: - - `maxlength=integer` (optional): The maximum number of characters accepted - - `size=integer` (optional): The size of the input field -- `Spinbox`: A GUI element for _IntegerValue_. A text field with and "up"- and "down"-button for increment/decrement. - The attributes "max=decimal" and "min=decimal" are optional. - - _gui_attributes_: - - `max=decimal` (optional): Maximal value - - `min=decimal` (optional): Minimal value +- `Checkbox`: A GUI element for _BooleanValue_. + - _gui_attributes_: No attributes *Example:* ```json { - "name": "hasInteger", + "name": "hasBoolean", "super": [ "hasValue" ], - "object": "IntValue", + "object": "BooleanValue", "labels": { - "en": "Integer" + "en": "Boolean value" }, - "gui_element": "Spinbox", - "gui_attributes": { - "max": 10.0, - "min": 0.0 - } + "gui_element": "Checkbox" } ``` -#### DecimalValue +#### ColorValue -`"object": "DecimalValue"` +`"object": "ColorValue"` -A number with decimal point. +A string representation of the color in the hexadecimal form e.g. "#ff8000". *gui-elements / gui_attributes*: -- `Slider`: A GUI element for _DecimalValue_. Provides a slider to select a decimal value. - - _gui_attributes_: - - `max=decimal` (mandatory): maximal value - - `min=decimal` (mandatory): minimal value -- `SimpleText`: A GUI element for _TextValue_. A simple text entry box (one line only). The attributes - "maxlength=integer" and "size=integer" are optional. +- `Colorpicker`: The only GUI element for _ColorValue_. It's used to choose a color. - _gui_attributes_: - - `maxlength=integer` (optional): maximum number of characters accepted - - `size=integer` (optional): size of the input field + - `ncolors=integer` (optional): Number of colors the color picker should present. *Example:* ```json { - "name": "hasDecimal", + "name": "hasColor", "super": [ - "hasValue" + "hasColor" ], - "object": "DecimalValue", + "object": "ColorValue", "labels": { - "en": "Decimal number" + "en": "Color" }, - "gui_element": "SimpleText", - "gui_attributes": { - "maxlength": 255, - "size": 80 - } + "gui_element": "Colorpicker" } ``` @@ -411,30 +347,68 @@ which means anytime in between 1925 and the 22nd March 1927. } ``` -#### TimeValue +#### DecimalValue -`"object": "TimeValue"` +`"object": "DecimalValue"` -A time value represents a precise moment in time in the Gregorian calendar. Since nanosecond precision can be included, it is suitable for use as a timestamp. +A number with decimal point. *gui-elements / gui_attributes*: -- `TimeStamp`: A GUI element for _TimeValue_ which contains a date picker and a time picker. - - _gui_attributes_: No attributes +- `Slider`: A GUI element for _DecimalValue_. Provides a slider to select a decimal value. + - _gui_attributes_: + - `max=decimal` (mandatory): maximal value + - `min=decimal` (mandatory): minimal value +- `SimpleText`: A GUI element for _TextValue_. A simple text entry box (one line only). The attributes + "maxlength=integer" and "size=integer" are optional. + - _gui_attributes_: + - `maxlength=integer` (optional): maximum number of characters accepted + - `size=integer` (optional): size of the input field *Example:* ```json { - "name": "hasTime", + "name": "hasDecimal", "super": [ "hasValue" ], - "object": "TimeValue", + "object": "DecimalValue", "labels": { - "en": "Time" + "en": "Decimal number" }, - "gui_element": "TimeStamp" + "gui_element": "SimpleText", + "gui_attributes": { + "maxlength": 255, + "size": 80 + } +} +``` + +#### GeonameValue + +Represents a location ID in geonames.org. DSP uses identifiers provided by +[geonames.org](https://geonames.orgs) to identify geographical locations. + +*gui-elements / gui_attributes*: + +- `Geonames`: The only valid GUI element for _GeonameValue_. It interfaces are with geonames.org and it allows to select + a location. + - _gui_attributes_: No attributes + +*Example:* + +```json +{ + "name": "hasGeoname", + "super": [ + "hasValue" + ], + "object": "GeonameValue", + "labels": { + "en": "Geoname" + }, + "gui_element": "Geonames" } ``` @@ -470,154 +444,178 @@ Represents a time-interval } ``` -#### BooleanValue +#### IntValue -`"object": "BooleanValue"` +`"object": "IntValue"` -Represents a Boolean ("true" or "false). +Represents an integer value. *gui-elements / gui_attributes*: -- `Checkbox`: A GUI element for _BooleanValue_. - - _gui_attributes_: No attributes +- `SimpleText`: A GUI element for _TextValue_. A simple text entry box (one line only). The attributes + "maxlength=integer" and "size=integer" are optional. + - _gui_attributes_: + - `maxlength=integer` (optional): The maximum number of characters accepted + - `size=integer` (optional): The size of the input field +- `Spinbox`: A GUI element for _IntegerValue_. A text field with and "up"- and "down"-button for increment/decrement. + The attributes "max=decimal" and "min=decimal" are optional. + - _gui_attributes_: + - `max=decimal` (optional): Maximal value + - `min=decimal` (optional): Minimal value *Example:* ```json { - "name": "hasBoolean", + "name": "hasInteger", "super": [ "hasValue" ], - "object": "BooleanValue", + "object": "IntValue", "labels": { - "en": "Boolean value" + "en": "Integer" }, - "gui_element": "Checkbox" + "gui_element": "Spinbox", + "gui_attributes": { + "max": 10.0, + "min": 0.0 + } } ``` -#### UriValue +#### ListValue -`"object": "UriValue"` +`"object": "ListValue"` -Represents an URI +Represents a node of a (possibly hierarchical) list *gui-elements / gui_attributes*: -- `SimpleText`: A GUI element for _TextValue_. A simple text entry box (one line only). The attributes - "maxlength=integer" and "size=integer" are optional. +- `Radio`: A GUI element for _ListValue_. A set of radio buttons. This works only with flat lists. - _gui_attributes_: - - `maxlength=integer` (optional): The maximum number of characters accepted - - `size=integer` (optional): The size of the input field + - `hlist=` (required): The reference of a [list](./dsp-tools-create.md#lists) root node +- `List`: A GUI element for _ListValue_. A list of values to select one from. This GUI element should be chosen for + hierarchical lists or flat lists that could be expanded to hierarchical lists in the future. + - _gui_attributes_: + - `hlist=` (required): The reference of a [list](./dsp-tools-create.md#lists) root node *Example:* ```json { - "name": "hasUri", + "name": "hasListItem", "super": [ "hasValue" ], - "object": "UriValue", + "object": "ListValue", "labels": { - "en": "URI" + "en": "List element" }, - "gui_element": "SimpleText", + "gui_element": "List", "gui_attributes": { - "maxlength": 255, - "size": 80 + "hlist": "treelistroot" } } ``` -#### GeonameValue +#### TextValue -Represents a location ID in geonames.org. DSP uses identifiers provided by -[geonames.org](https://geonames.orgs) to identify geographical locations. +`"object": "TextValue"` -*gui-elements / gui_attributes*: +Represents a text that may contain standoff markup. -- `Geonames`: The only valid GUI element for _GeonameValue_. It interfaces are with geonames.org and it allows to select - a location. +*gui_elements / gui_attributes*: + +- `SimpleText`: A GUI element for _TextValue_. A simple text entry box (one line only). The attributes are: + - _gui_attributes_: + - `maxlength=integer` (optional): maximal length (number of characters accepted) + - `size=integer` (optional): size (width) of widget +- `Textarea`: A GUI element for _TextValue_. Presents a multiline text entry box. The optional attributes are: + - _gui_attributes_: + - `cols=integer` (optional): number of columns of the textarea + - `rows=integer` (optional): number of rows of the textarea + - `width=percent` (optional): width of the textarea on screen + - `wrap=soft|hard` (optional): wrapping of text +- `Richtext`: A GUI element for _TextValue_. Provides a richtext editor. - _gui_attributes_: No attributes *Example:* ```json { - "name": "hasGeoname", + "name": "hasPictureTitle", "super": [ "hasValue" ], - "object": "GeonameValue", + "object": "TextValue", "labels": { - "en": "Geoname" + "en": "Title" }, - "gui_element": "Geonames" + "gui_element": "SimpleText", + "gui_attributes": { + "maxlength": 255, + "size": 80 + } } ``` -#### ColorValue +#### TimeValue -`"object": "ColorValue"` +`"object": "TimeValue"` -A string representation of the color in the hexadecimal form e.g. "#ff8000". +A time value represents a precise moment in time in the Gregorian calendar. Since nanosecond precision can be included, it is suitable for use as a timestamp. *gui-elements / gui_attributes*: -- `Colorpicker`: The only GUI element for _ColorValue_. It's used to choose a color. - - _gui_attributes_: - - `ncolors=integer` (optional): Number of colors the color picker should present. +- `TimeStamp`: A GUI element for _TimeValue_ which contains a date picker and a time picker. + - _gui_attributes_: No attributes *Example:* ```json { - "name": "hasColor", + "name": "hasTime", "super": [ - "hasColor" + "hasValue" ], - "object": "ColorValue", + "object": "TimeValue", "labels": { - "en": "Color" + "en": "Time" }, - "gui_element": "Colorpicker" + "gui_element": "TimeStamp" } ``` +#### UriValue -#### ListValue - -`"object": "ListValue"` +`"object": "UriValue"` -Represents a node of a (possibly hierarchical) list +Represents an URI *gui-elements / gui_attributes*: -- `Radio`: A GUI element for _ListValue_. A set of radio buttons. This works only with flat lists. - - _gui_attributes_: - - `hlist=` (required): The reference of a [list](./dsp-tools-create.md#lists) root node -- `List`: A GUI element for _ListValue_. A list of values to select one from. This GUI element should be chosen for - hierarchical lists or flat lists that could be expanded to hierarchical lists in the future. +- `SimpleText`: A GUI element for _TextValue_. A simple text entry box (one line only). The attributes + "maxlength=integer" and "size=integer" are optional. - _gui_attributes_: - - `hlist=` (required): The reference of a [list](./dsp-tools-create.md#lists) root node + - `maxlength=integer` (optional): The maximum number of characters accepted + - `size=integer` (optional): The size of the input field *Example:* ```json { - "name": "hasListItem", + "name": "hasUri", "super": [ "hasValue" ], - "object": "ListValue", + "object": "UriValue", "labels": { - "en": "List element" + "en": "URI" }, - "gui_element": "List", + "gui_element": "SimpleText", "gui_attributes": { - "hlist": "treelistroot" + "maxlength": 255, + "size": 80 } } ```