Portal config schema

Type: object

A schema describing the portal configuration file.

root portalID
Type: string

String specifying the id for the portal.

root rootUrl
Type: string

root perspectives
Type: object

root perspectives searchPerspectives
Type: array

Array containing the perspective ids of those perspectives that can be searched.

Tuple Validation

Item at 1 must be:
root perspectives searchPerspectives searchPerspectives item 0
Type: string

String specifying the perspective id.

root perspectives onlyInstancePages
Type: array

Array containing the perspective ids of those perspectives that only have instance pages.

Tuple Validation

Item at 1 must be:
root perspectives onlyInstancePages onlyInstancePages item 0
Type: string

String specifying the perspective id.

root localeConfig
Type: object

root localeConfig defaultLocale
Type: string

String specifying the language code of the default locale.

root localeConfig readTranslationsFromGoogleSheets
Type: boolean

Boolean indicating whether or not translations should be read from Google Sheets or not.

root localeConfig availableLocales
Type: array

An array containing the required language data for the available locales.

Tuple Validation

Item at 1 must be:
root localeConfig availableLocales availableLocales item 0
Type: object

root localeConfig availableLocales availableLocales item 0 id
Type: string

String specifying the language code of the language.

root localeConfig availableLocales availableLocales item 0 label
Type: string

String specifying the label for the language.

root localeConfig availableLocales availableLocales item 0 filename
Type: string

String specifying the file name where the locale translations are stored.

root sitemapConfig
Type: object

An object containing sitemap configurations.

root sitemapConfig baseUrl
Type: string

String specifying the base URL of the portal.

root sitemapConfig langPrimary
Type: string

String specifying the language code of the primary language used.

root sitemapConfig langSecondary
Type: string

String specifying the language code of the secondary language used.

root sitemapConfig outputDir
Type: string

String specifying the directory where the sitemap is outputted.

root sitemapConfig sitemapUrl
Type: string

String specifying the URL for the sitemap.

root sitemapConfig sitemapInstancePageQuery
Type: enum (of string)

Must be one of:

  • "sitemapInstancePageQuery"

root knowledgeGraphMetadataConfig
Type: object

root knowledgeGraphMetadataConfig showTable
Type: boolean

Boolean indicating whether a table should be shown.

root knowledgeGraphMetadataConfig perspective
Type: string

String specifying the perspective for the knowledge graph metadata.

root layoutConfig
Type: object

root layoutConfig colorPalette
Type: object

An object representing the information about the site color palette.

root layoutConfig colorPalette primary
Type: object

An object representing the primary colors of the color palette.

root layoutConfig colorPalette primary main
Type: string

String specifying the hex color code for the main primary color.

root layoutConfig colorPalette secondary
Type: object

An object representing the secondary colors of the color palette.

root layoutConfig colorPalette secondary main
Type: string

String specifying the hex color code for the main secondary color.

root layoutConfig hundredPercentHeightBreakPoint
Type: integer

Integer specifying the breakpoint for hundred percent height.

root layoutConfig reducedHeightBreakpoint
Type: integer

Integer specifying the breakpoint for reduced height.

root layoutConfig tabHeight
Type: integer

Integer specifying tab height.

root layoutConfig paginationToolbarHeight
Type: integer

Integer specifying the pagination toolbar height.

root layoutConfig tableFontSize
Type: string

String specifying the font size or the table.

root layoutConfig topBar
Type: object

An object representing the top navigation bar of the site.

root layoutConfig topBar logoImage
Type: string

String specifying the image path of the logo image.

root layoutConfig topBar logoTextTransform
Type: enum (of string)

String specifying the transformation done to the logo text.

Must be one of:

  • "none"
  • "capitalize"
  • "uppercase"
  • "lowercase"
  • "full-width"
  • "full-size-kana"

root layoutConfig topBar hideLogoTextOnMobile
Type: boolean

Boolean indicating whether the logo text should be hidden on mobile.

root layoutConfig topBar showLanguageButton
Type: boolean

Boolean indicating whether the language button should be shown.

root layoutConfig topBar showSearchField
Type: boolean

Boolean indicating whether the search field should be shown in the top navigation bar.

root layoutConfig topBar externalInstructions
Type: boolean

Boolean indicating whether the instructions page is external.

root layoutConfig topBar externalAboutPage
Type: boolean

Boolean indicating whether the about page is external.

root layoutConfig topBar reducedHeight
Type: integer

Integer specifying the height of the topbar when it is in reduced height.

root layoutConfig topBar defaultHeight
Type: integer

Integer specifying the height of the topbar.

root layoutConfig topBar mobileMenuBreakpoint
Type: integer

Integer specifying the breakpoint for the mobile menu.

root layoutConfig topBar infoDropdown
Type: array

An object representing the information shown in the info dropdown in the top navigation bar.

Tuple Validation

Item at 1 must be:
root layoutConfig topBar infoDropdown infoDropdown item 0
Type: object

root layoutConfig topBar infoDropdown infoDropdown item 0 id
Type: string

String specifying the id for this dropdown item.

root layoutConfig topBar infoDropdown infoDropdown item 0 translatedUrl
Type: string

String specifying the property name used in locale translations to refer to this item's URL.

root layoutConfig topBar infoDropdown infoDropdown item 0 translatedText
Type: string

String specifying the property name used in locale translations to refer to this item's text.

root layoutConfig mainPage
Type: object

root layoutConfig mainPage bannerImage
Type: string

String specifying the image path to the main page banner image.

root layoutConfig mainPage bannerBackround
Type: string

String specifying the CSS value for the banner background.

root layoutConfig mainPage bannerMobileHeight
Type: integer

Integer specifying the height of the main page banner on mobile.

root layoutConfig mainPage bannerReducedHeight
Type: integer

Integer specifying the height of the main page banner when it is reduced in its height.

root layoutConfig mainPage bannerDefaultHeight
Type: integer

Integer specifying the height of the main page banner.

root layoutConfig mainPage wrapSubheading
Type: boolean

Boolean indicating whether the subheading on the main page should wrap.

root layoutConfig infoHeader
Type: object

An object representing the info header on the site.

root layoutConfig infoHeader default
Type: object

An object representing the info header's properties when it is in its default state.

root layoutConfig infoHeader default height
Type: integer

Integer specifying the height of the info header when it is not expanded.

root layoutConfig infoHeader default expandedContentHeight
Type: integer

Integer specifying the height of the info header when expanded.

root layoutConfig infoHeader default headingVariant
Type: enum (of string)

String specifying the heading variant used.

Must be one of:

  • "h1"
  • "h2"
  • "h3"
  • "h4"
  • "h5"
  • "h6"

root layoutConfig infoHeader default infoIconFontSize
Type: integer

Integer specifying the font size for the info icon.

root layoutConfig infoHeader reducedHeight
Type: object

An object representing the info header's properties when it is reduced in height.

root layoutConfig infoHeader reducedHeight height
Type: integer

Integer specifying the height of the info header when it is not expanded.

root layoutConfig infoHeader reducedHeight expandedContentHeight
Type: integer

Integer specifying the height of the info header when expanded.

root layoutConfig infoHeader reducedHeight headingVariant
Type: enum (of string)

String specifying the heading variant used.

Must be one of:

  • "h1"
  • "h2"
  • "h3"
  • "h4"
  • "h5"
  • "h6"

root layoutConfig infoHeader reducedHeight infoIconFontSize
Type: integer

Integer specifying the font size for the info icon.

root mapboxConfig
Type: object

root mapboxConfig mapboxStyle
Type: enum (of string)

String specifying the wanted style for the mapbox.

Must be one of:

  • "streets-v11"
  • "outdoors-v11"
  • "light-v10"
  • "dark-v10"
  • "satellite-v9"
  • "satellite-streets-v11"
  • "navigation-day-v1"
  • "navigation-night-v1"

root yasguiConfig
Type: object

An object representing the YASGUI configuration.

root yasguiConfig yasguiBaseURL
Type: string

String specifying the base URL for YASGUI.

root yasguiConfig yasguiParams
Type: object

root yasguiConfig yasguiParams contentTypeConstruct
Type: string

String specifying the content type for CONSTRUCT (e.g. 'text/turtle').

root yasguiConfig yasguiParams contentTypeSelect
Type: string

String specifying the content type for SELECT (e.g. 'application/sparql-results+json').

root yasguiConfig yasguiParams endpoint
Type: string

String specifying the endpoint to be used in YASGUI.

root yasguiConfig yasguiParams requestMethod
Type: enum (of string)

Specifies the request method used.

Must be one of:

  • "POST"

root yasguiConfig yasguiParams tabTitle
Type: string

String specifying the tab title to be used for the opened tab in YASGUI editor.

root documentFinderConfig
Type: object

An object representing the information for document finder configuration.

root documentFinderConfig apiURL
Type: string

String specifying the API URL for the document finder.