Namespace: help

Help4.widget.help

Source:

Classes

CatalogueBackend
Cookie
Data
Widget
XmlHelper

Namespaces

catalogues
project
view2

Type Definitions

Catalogue

Type:
  • Object
Properties:
Name Type Description
projects Array.<Help4.widget.help.CatalogueProject> list of projects
selected Object selected projects per screen; an array of Help4.widget.help.CatalogueSelection per screen
Source:

CatalogueKeys

Type:
  • 'pub' | 'head'
Source:

CatalogueProject

Type:
  • Object
Properties:
Name Type Attributes Description
alias string alternative project name; internally added
conditions Array possible conditions
cloneSrc string <optional>
 reduced clone source of project; internally added
contextType Help4.widget.help.ContextTypes context type
hidden boolean whether project is hidden for end-users
id string project ID
language string project language
loio string project LOIO (LOgical Info Object)
modificationTime string time of last modification
product string context information
published Help4.widget.help.PUBLISHED_STATUS project published information
screen string screen ID
system string context information
title string title of the project
version string context information
_catalogueType Help4.widget.help.CatalogueTypes SEN, SEN2, UACP, ...; internally added
_dataType Help4.widget.help.DataTypes SEN, UACP, ...; internally added
_ext string | null <optional>
 ext information for RO projects: - this project is extended by the project with id
_ignore boolean <optional>
 ext information for RW projects: project is removed by EXT, e.g. due to low-priority language
_ro string | null <optional>
 ext information for RW projects: - this project extends the project with id
_whatsnew boolean <optional>
 whether project is a whatsnew one
Source:

CatalogueSelection

Type:
  • Object
Properties:
Name Type Attributes Description
catalogueType Help4.widget.help.CatalogueTypes backend ID
id string project ID
catalogueType2 Help4.widget.help.CatalogueTypes <optional>
 backend ID; EXT
id2 string <optional>
 project ID; EXT
Source:

CatalogueTypeExtension

Type:
Properties:
Name Type Description
widgetHelpCatalogue 'widgetHelpCatalogue'
Source:

CatalogueTypes

Type:
  • 'SEN' | 'SEN2' | 'UACP' | 'GlobalHelp' | 'API' | 'QuickTour' | 'UR'
Source:

Catalogues

Type:
  • Object
Properties:
Name Type Description
pub Help4.widget.help.Catalogue public catalogue projects for end-users
head Help4.widget.help.Catalogue non-public catalogue projects for authors
Source:

ConditionProjectTile

Type:
Properties:
Name Type Description
_conditionResult boolean
Source:

ContextTypes

Type:
  • 'HELP' | 'TOUR'
Source:

DataTypes

Type:
  • 'SEN' | 'UACP'
Source:

HeadersXml

Type:
  • Object
Properties:
Name Type Description
start_unit Help4.widget.help.HeadersXmlMacroDefinition
define_target Help4.widget.help.HeadersXmlMacroDefinition
help_tile Help4.widget.help.HeadersXmlMacroDefinition
link_tile Help4.widget.help.HeadersXmlMacroDefinition
guide_click Help4.widget.help.HeadersXmlMacroDefinition
Source:

HeadersXmlMacroDefinition

Type:
  • Object
Properties:
Name Type Description
Duration number
NoExport Array.<string>
ParamSet Array.<Object>
Source:

HelpSelection

Type:
  • Object
Properties:
Name Type Description
pub Array.<Help4.widget.help.Project>
head Array.<Help4.widget.help.Project>
Source:

PUBLISHED_STATUS

Type:
  • string
Properties:
Name Type Description
invalid null no published information available
published 'published' this item is completely published
updated 'updated' this item has been updated after publishing
new 'new' this item is new and not published at all
Source:

Project

Type:
  • Object
Properties:
Name Type Attributes Description
alias string
conditions Object
contextType Help4.widget.help.ContextTypes
hidden boolean <optional>
 authors only
id string
language string
loio string
playbackTag Help4.widget.help.PUBLISHED_STATUS <optional>
 authors only
product string
published Help4.widget.help.PUBLISHED_STATUS <optional>
 authors only
screen string
system string
tiles Array.<Help4.widget.help.ProjectTile>
title string
version string
_catalogueType Help4.widget.help.CatalogueTypes SEN, SEN2, UACP, ...; internally added
_dataType Help4.widget.help.DataTypes SEN, UACP, ...; internally added
_standalone boolean
_ext 'ext' | 'ro' | 'rw' <optional>
 EXT mode
_rw string <optional>
 EXT: ID of the EXT project from RW
Source:

ProjectTile

Type:
  • Object
Properties:
Name Type Attributes Description
alignWithText boolean
autoProgress Array.<string>
autoSkipStep boolean
bubbleAnimationType Help4.typedef.BubbleAnimationType
bubbleOffset Help4.control2.PositionLeftTop
bubbleOrientation Help4.typedef.BubbleOrientation
bubbleSize string
bubbleType Help4.typedef.BubbleType
callout boolean
conditions Array.<*>
content string
elementType string
hidden boolean
hotspotAnchor string <nullable>
hotspotAnimationType string
hotspotCentered boolean
hotspotIconPos Help4.typedef.HotspotIconPosition
hotspotIconType Help4.typedef.HotspotIconType
hotspotId string
hotspotManualOffset Help4.control2.PositionLeftTop
hotspotOffset boolean
hotspotRectDelta Help4.control2.SizeWidthHeight
hotspotSize string
hotspotSpotlight boolean
hotspotSpotlightBlur number
hotspotSpotlightOffset number
hotspotSpotlightOpacity number
hotspotStyle string
hotspotTrianglePos string
id string
instantHelp boolean
language string <optional>
lightboxSize Help4.control2.SizeWidthHeight
lightboxSizing string
linkLightbox boolean
linkTo string
loio string
pageUrl string
showArrow boolean
showAsButton boolean
showTitleBar boolean
showDetach boolean <optional>
fullCover boolean <optional>
splash boolean
splashOption Help4.typedef.SplashOption
summaryText string
tileIcon Help4.typedef.TileIcons
tileOrder number
title string
type string
_catalogueKey Help4.widget.help.CatalogueKeys <optional>
_catalogueType Help4.widget.help.CatalogueTypes
_ctx Array.<Object>
_dataType Help4.widget.help.DataTypes
_mac Help4.widget.help.project.SEN.LessonJsMacro
_hiddenAnnouncement boolean <optional>
_projectId string
_special string <nullable>
_standalone boolean
_reference boolean
_isUR boolean <optional>
_translation Object <optional>
Properties
Name Type Attributes Description
content string <optional>
title string <optional>
Source:

Projects

Type:
  • Object
Properties:
Name Type Attributes Description
pub Help4.widget.help.Project <nullable>
 public project for end-users
head Help4.widget.help.Project <optional>
<nullable>
 non-public project for authors
Source:

TileDescriptor

Type:
  • Object
Properties:
Name Type Attributes Description
tileId string <optional>
projectId string
catalogueType Help4.widget.help.CatalogueTypes
catalogueKey Help4.widget.help.CatalogueKeys <optional>
dataType Help4.widget.help.DataTypes <optional>
projectVersion string <optional>
Source:

TileParams

Type:
  • Object
Properties:
Name Type Attributes Description
_tile Help4.widget.help.ProjectTile
_data Object <optional>
_metadata Object
Properties
Name Type Description
descriptor Help4.widget.help.view2.Tile.Descriptor
type 'tile'
originalDescription string
isGlobalHelp boolean
controlType string
icon string <nullable>
isGlobalHelp boolean
showAsButton boolean
linkLightbox boolean
hidden boolean
caption string
description string
title string
type string
css string
active boolean
visible boolean
contentLanguage string
Source: