Content Display & Viewing

these components focus on rendering individual or structured help content, such as topics, reading lists, images, or videos they support in place viewing, editing (for authors), and features like callouts or full templates topic viewer ( ihdetail ) displays a help topic and includes in place editing facilities for help authors the topic viewer component is one of two main ways to show individual help topics (i e , nuggets of useful content), the other being via embedded help callouts presented via the autoform best used for/key features knowledge display wiki style linking flow screen help admin insights & deployment tips use stand alone or inside utility 1 / tabset; embed in flows for step specific help example use cases show dynamic help for each flow screen expected business outcomes less frustration higher task completion layoutinfodelimiters ( layoutinfodelimiters ) this is not a component design parameter but is available to code (so can, for example, be supplied when creating composite components or building via the lightning out host page) this parameter can be used to specify the delimiters that are to be used when specifying the component’s layout definition ( layoutinfo parameter) if supplied, this should be a 4 character string, each character being one of the delimiters, as follows character 1 row delimiter character 2 column delimiter character 3 field delimiter character 4 field attribute delimiter this value defaults to |¬,^ , a value that is suited to most needs topic layout component definition ( layoutinfo ) instructions for customising the layout of help topic data when presented via this component the instructions are supplied as a delimited string, as follows the custom layout is construed as a series of ‘rows’, each of which is 100 percent page width with a height that will grow as required to accommodate the specified content each row contains between 1 and 12 columns columns are of equal width each column contains “fields” (pieces of layout information of various kinds, which may or may not be actual object fields) fields are supplied as a delimited definition, in the form content \[delimiter] type \[delimiter] class the delimited field definition is as follows content defines the piece of information to be displayed interpretation of the value supplied is dependent on… type one of the following values field content is assumed to be the api name (including the iahelp namespace prefix) of a field of the help topic object the unescaped value of the specified field will be placed in the column literal content is assumed to be plain text, to be placed in the column ‘as is’, regardless of the help topic in play component content is assumed to be a further delimited string of instructions for creating an aura component the component is placed in the column contact support for further information image content is assumed to be the api name (including the iahelp namespace prefix) of a field of the help topic object that contains the url of an image a div tag will be added to the column, sized at help topic’s specified image video width and height,wwith its background set to the url video content is assumed to be the api name (including the iahelp namespace prefix) of a field of the help topic object that contains the url of a video an iframe will be added to the column, sized at help topic’s specified width and height, with its source set to the url class the name of a css class to apply to the content content is added to the column inside a div that is styled with this class delimiters are single characters, as specified by the layoutinfodelimiters attribute custom layout example an example of the overall format of the component definition string by way of example, the following settings could be used topic layout component definition ( layoutinfo ) iahelp summary c^field^slds text heading large|iahelp imageurl c^image^¬iahelp description c^field^| layoutinfodelimiters leave at the default setting, which is |¬,^ the setting amounts to the following (white space added for clarity) \[a field name] \[field attribute delimiter] \[type = field] \[field attribute delimiter] \[the css class to apply to the field] \[row delimiter] \[a field name] \[field attribute delimiter] \[type = image] \[field attribute delimiter] \[no class specified item will be un styled] \[column delimiter] \[a field name] \[field attribute delimiter] \[type = field] \[field attribute delimiter] \[no class specified item will be un styled] \[row delimiter] we thus produce a two row layout the first row contains a single field (summary) with specified styling the second row contains two columns, each with a single field one is to be displayed as an image the second is to be treated as a field so the help topic’s description is placed in the right hand column topic layout source ( layoutinfoprecedence ) where custom layouts are used, defines which layout definition (topic's, as specified by its full template, or component's, as specified via this parameter on a given page layout) takes precedence cache source ( cachedrecordsource ) allows the component to retrieve and display a pre cached version of a help record (e g , a help topic) from another component or source, rather than fetching it directly from salesforce every time leave blank to seek topic data from salesforce server side as users select topics setting a cache source —for example to a tree or list that the topic viewer is listening to— will result in faster navigation between topics some topic features are not supported in this mode listens to ( listensto ) comma separated list of the component(s) that this component should 'listen' to (respond to events from) to listen to the quick access menu, enter theqam default help topic ( helprecordid ) id of the help topic to display on loading leave blank to show the org's default help topic as defined in global settings) enter \[none] to start with no topic, regardless of the org's default reading list viewer ( ihrlviewer ) this component displays a reading list and, optionally, related navigation controls best used for/key features onboarding journeys process documentation mobile ready admin insights & deployment tips add to sub tabs in training or help apps; supports different display modes example use cases ‘first 5 steps in opportunity management’ expected business outcomes consistent learning experience repeatable training entry presentation style ( rlestyle ) (adopter component style only) controls how reading list entries will be displayed simple text presentation shows the summary only of each reading list entry in a plain text format topic viewer presentation displays the entire reading list entry via a help topic viewer component component style ( rlstyle ) controls the overall visual treatment of the reading list standard style is our original lightning reading list treatment, featuring optional navigation lozenges and a linear presentation of entries adopter style is a more modern, branded treatment with entries that can be expanded and collapsed this style also supports multi page guides video aspect ratio ( videoaspectratio ) ratio of width to height to use when displaying video media select from hd (16 9) monitor (4 3) widescreen (5 3) the aspect ratio will be applied to all video media, regardless of source sizing media width ( mediawidth ) percentage width at which to display reading list entry image and/or video select 50 , 75 or 100 percent any images featured in the reading list’s entries will be displayed at the selected percentage of the width of the viewer, with height varying as required to retain the aspect ratio of the original picture show entry descriptions ( showdescriptions ) switches the display of reading list entry description text on or off show navigation bar ( shownavbar ) shows or hides the reading list entries navigation bar reading list entry viewed help interactions are only logged when clicking entry lozenges on the navigation bar merely scrolling the viewer logs no interactions default reading list ( helprecordid ) id of the reading list to display on loading (leave blank to await instructions from the component this one 'listens to') media viewer ( ihimageviewer ) this component displays media (image or video) in various formats, be they sourced from help topics or elsewhere best used for/key features visual training process illustrations admin insights & deployment tips embed in training or help tabs; ideal for short tutorials expected business outcomes improved learning retention in addition to being available for standalone use, the media viewer can be invoked as a modal dialogue by clicking on the popout media tool adjacent to any image or video displayed via the topic viewer listens to ( listensto ) comma separated list of the component(s) that this component should 'listen' to (respond to events from) to listen to the quick access menu, enter theqam default media title ( imagetitle ) this is the title to display with the default image if the component receives help topic information as described above, the component’s title reverts to help topic name plus image title, where available media type ( mediamode ) the type of (image or video) media displayed by the specified default media url default media url ( imageurl ) the https address of the item (image or video) to display this component is driven by the url of an image or video, as opposed to the id of a help topic or record of any kind in common with other components, the image viewer is able to listen to its peers and, if supplied thereby with a help topic id (via the topic selected event) it will retrieve the url of the associated media and display it the default media url is the https address of the item (image or video) to show when the viewer is first displayed, prior to any topic selected event advising the component of the “current” item to load listing ( ihlist ) this component shows lists of contextual and / or related help topics, reading lists, personal notes or resources best used for/key features knowledge navigation content apps utility bar access searchable lists admin insights & deployment tips use within tabs or utility bar; filter by tags or context example use cases 'related guides' list on opportunity page expected business outcomes quicker content discovery higher self service action code ( listingclickactioncode ) an action code to raise when items on the listing are clicked the listing component communicates with others which are listening (see component id and listens to parameters) by generating messages ( action codes ) when its row items are clicked a default action code is associated with each listing style that we package with improved help this parameter can be used to override this default, with a view to triggering custom actions defined in your org's own code contact support for more information regarding this option collapse tools at ( maxlistingtools ) the maximum number of listing tools to show against list rows before collapsing them into an ellipsis 0 = always collapse, 1 = never collapse this does not affect items in the tools menu these apply to the component as a whole, rather than specific records and are always collapsed until the tools icon is clicked listens to ( listensto ) defines the component(s) that this component should 'listen' to (for utility 1, pdlistensto ) for the list component, the id ofa single component that this component should 'listen' to (respond to events from) for other components, a comma separated list of component ids may be entered to listen to the quick access menu, enter 'theqam' if no value is provided, the list will effectively be static throughout the life of the page whilst this can be useful in some circumstances, for the "related help" and "resources" listing types, a blank value is not suitable as the listing will have no means of knowing the topic for which related items are to be shown listing row style ( listingrowstyle ) the row format to use in this component select from expanded shows the ‘title’ text associated with each row of data when listing help topics, for example, this will be the topic summary text hidden shows only the name of each record depending on lux interaction tracking status, context and the configuration tools available in a given org, the user may be allowed to expand / contract list details themselves, with the component setting representing only an initial default listing type ( cardconfig ) the (related) list type to display in this component select from all help the listing will show the topics associated with every element defined for the current helped page layout on a record page, this will be determined, as in classic, by examining the current record id if in a custom “app” page, use “fixed help” (see below) bookmarks shows the current user’s list of bookmarked topics child help shows any help topics that are children of the one selected on the component to which the listing is listening (i e , are related via a help relationship whose semantic tag is ‘parent’) this listing will always be a subset of that returned when using the ‘related help’ option(which shows relatives of all semantic types) fixed help the listing will show the topics associated with every element applicable to the helped page layout implied by the “fixed help context” parameter tagged items shows items that have been “tagged” with a particular meta topic (see tagging control) help notes lists the user’s “sticky” notes for the current context (record id or “fixed” ibid) notes are a particular kind of help interaction, so lux interactions must be enabled to use this option note that when on a record layout, notes are contextual to the individual row of data being viewed (i e , the particular account / opportunity etc ) on arrival at any given context, a new note will be created automatically if one does not exist in the user’s name notes effectively retain a version history any edits are recorded in a new interaction, with all previous copies of the interaction retained reading lists shows any reading list that contains entries whose topics feature in the current context, plus any featured reading lists related help shows any help topics related to the one selected on the component to which the listing is listening resources shows any help resources related to the one selected on the component to which the listing is listening unfeatured reading lists as reading lists, but excludes any featured items in this way, one is able to obtain reading lists that are directly related to the current context topic labelling option ( rowlabellingoption ) for help topic listings, the fields to display for each row select from element name topic name topic name (element type) topic name this setting is ignored for listings other than help topics listing tile size ( listingtilesize ) the size of tile to display for each listing item for tile listing style only overall listing style ( listingstyle ) the listing format to use in this component select from narrow suited to minimal screen real estate (and hard wired for the listing featured in the qam) tile displays each listing item as a ‘tile’ rather than row in a table wide a more open and expansive listing style record id ( recordid ) this attribute is not exposed to the lightning page designer but may need to be set when adding list components via mark up many improved help components are informed automatically by salesforce of the id of the record being visited by the user, where relevant the record id parameter traps this information this attribute is not exposed to the lightning page designer as a parameter, but may need to be set in some specific circumstances when adding list components via mark up default / tag pool help topic ( helprecordid ) id of the help topic to which to contextualise, where relevant for related listing and tagged items types, the id of the help topic to which to contextualise on load fixed help context (sobjectname) the object type (api name) to which to contextualise, where relevant for a standalone or fixed help listing, the object type (api name) to which to contextualise for the tagged items option, the id of the topic with which listing items must be tagged in order to appear callout option ( calloutoption ) where relevant to the list being viewed, controls how to respond to listing item clicks select from topic selected event only when a listing is clicked, the listing will issue a record selected message that other components may choose to listen for and respond to topic selected event plus topic view when clicked, the listing issues the event but also opens a callout on the relevant item when listing help topics, this will be the topic’s chosen callout when listing reading lists, this will be a modal dialogue showing the reading list viewer for other list types, this selection is no different from “selected event only” topic selected event plus topic pop out as topic view, but opens the callout in a separate browser window