No edit summary
No edit summary
Line 6: Line 6:
{{FAQ row|q=[purpose]|a=The main object for everything that's *not* metadata, but just actual content.}}
{{FAQ row|q=[purpose]|a=The main object for everything that's *not* metadata, but just actual content.}}
{{FAQ group begin|header=restrictions}}
{{FAQ group begin|header=restrictions}}
{{FAQ row|q=[purpose]|a=Defining information, warning or error messages the user should receive when they are making a plan in which two particular layers collide.}}
{{FAQ group begin|header=[first_layer_name]|[second_layer_name]}}
{{FAQ group begin|header=[first_layer_name]|[second_layer_name]}}
{{FAQ row|q=[purpose]|a=The two colliding layers in question, for which the information, warning or error message can be defined.}}
{{FAQ row|q=message|a=string with message that the user should get when the two layers collide.}}
{{FAQ row|q=message|a=string with message that the user should get when the two layers collide.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=plans}}
{{FAQ group begin|header=plans}}
{{FAQ row|q=[purpose]|a=Defining starting plans, i.e., plans ready for implementation from the very start of the session, already put in place upon session creation.}}
{{FAQ row|q=plan_id|a=unique integer to simply identify the plan with.}}
{{FAQ row|q=plan_id|a=unique integer to simply identify the plan with.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=dependencies}}
{{FAQ group begin|header=dependencies}}
{{FAQ row|q=[purpose]|a=Setting up the Impact Tool window's content.}}
{{FAQ group begin|header=groups}}
{{FAQ group begin|header=groups}}
{{FAQ row|q=[purpose]|a=Defining the layers or variables and their groupings that make up the circle diagram that is the Impact Tool.}}
{{FAQ row|q=name|a=string representing the group of layers or variables shown in the Impact Tool.}}
{{FAQ row|q=name|a=string representing the group of layers or variables shown in the Impact Tool.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=links}}
{{FAQ group begin|header=links}}
{{FAQ row|q=[purpose]|a=Defining the lines that should be drawn between each layer or variable (in turn defined above under 'groups').}}
{{FAQ row|q=fromId|a=integer of the group entry (the layer or variable defined under 'groups') from with the draw an arrow in the Impact Tool.}}
{{FAQ row|q=fromId|a=integer of the group entry (the layer or variable defined under 'groups') from with the draw an arrow in the Impact Tool.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=CEL}}
{{FAQ group begin|header=CEL}}
{{FAQ row|q=[purpose]|a=Defining parameters particular to the CEL energy simulation software.}}
{{FAQ row|q=grey_centerpoint_color|a=string starting with hash (#) of the 8-digit hexadecimal colour code, the last two representing transparency.}}
{{FAQ row|q=grey_centerpoint_color|a=string starting with hash (#) of the 8-digit hexadecimal colour code, the last two representing transparency.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=SEL}}
{{FAQ group begin|header=SEL}}
{{FAQ row|q=[purpose]|a=Defining parameters particular to the SEL shipping simulation software.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=MEL}}
{{FAQ group begin|header=MEL}}
{{FAQ row|q=[purpose]|a=Defining parameters particular to the MEL ecosystem simulation software.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=meta}}
{{FAQ group begin|header=meta}}
{{FAQ row|q=[purpose]|a=Defining vector and raster data layers that should be shown in the appropriate left-hand side menu.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=expertise_definitions}}
{{FAQ group begin|header=expertise_definitions}}
{{FAQ row|q=[purpose]|a=Defining expertises that should be selectable from the drop-down list shown when logging on to a session.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ group begin|header=objectives}}
{{FAQ group begin|header=objectives}}
{{FAQ row|q=[purpose]|a=Defining default objectives that should be shown in the Objectives Monitor.}}
{{FAQ group end}}
{{FAQ group end}}
{{FAQ row|q=edition_name|a=string representing the chosen name of the edition that this configuration creates.}}
{{FAQ row|q=edition_name|a=string representing the chosen name of the edition that this configuration creates.}}
{{FAQ group end}}
{{FAQ group end}}

Revision as of 13:34, 23 November 2023

metadata
[purpose]
The main object for all things metadata, i.e., data about this data.
date_modified
string with format dd/mm/yyyy representing the date the file was last modified
datamodel
[purpose]
The main object for everything that's *not* metadata, but just actual content.
restrictions
[purpose]
Defining information, warning or error messages the user should receive when they are making a plan in which two particular layers collide.
[first_layer_name]
[purpose]
The two colliding layers in question, for which the information, warning or error message can be defined.
message
string with message that the user should get when the two layers collide.
plans
[purpose]
Defining starting plans, i.e., plans ready for implementation from the very start of the session, already put in place upon session creation.
plan_id
unique integer to simply identify the plan with.
dependencies
[purpose]
Setting up the Impact Tool window's content.
groups
[purpose]
Defining the layers or variables and their groupings that make up the circle diagram that is the Impact Tool.
name
string representing the group of layers or variables shown in the Impact Tool.
links
[purpose]
Defining the lines that should be drawn between each layer or variable (in turn defined above under 'groups').
fromId
integer of the group entry (the layer or variable defined under 'groups') from with the draw an arrow in the Impact Tool.
CEL
[purpose]
Defining parameters particular to the CEL energy simulation software.
grey_centerpoint_color
string starting with hash (#) of the 8-digit hexadecimal colour code, the last two representing transparency.
SEL
[purpose]
Defining parameters particular to the SEL shipping simulation software.
MEL
[purpose]
Defining parameters particular to the MEL ecosystem simulation software.
meta
[purpose]
Defining vector and raster data layers that should be shown in the appropriate left-hand side menu.
expertise_definitions
[purpose]
Defining expertises that should be selectable from the drop-down list shown when logging on to a session.
objectives
[purpose]
Defining default objectives that should be shown in the Objectives Monitor.
edition_name
string representing the chosen name of the edition that this configuration creates.
This page was last edited on 23 November 2023, at 13:34. Content is available under GPLv3 unless otherwise noted.