Help widget

Key point: Display a help article on the homepage.

This widget displays the content of a help document directly in the homepage.

It can be configured to show either a custom help article or a built-in help article from PageSeeder.

If the widget displays a cross icon icon on the top-right end corner, you can dismiss it so that it no longer shows on your homepage. If the referenced help document is modified, the widget displays it again.

Links open in the help panel.

info-circle icon

The title of the widget in the user interface is the same as the title of the help document.

Display

Small

Small help widget

Medium

Medium dismissible help widget with custom help content

Configuration

The ID of this widget is help.

It supports the following parameters:

Name Type Description Default
dismissible Boolean Whether to display the bookmarks as buttons false
path String Path to built-in PageSeeder help /help
project String Name of project for custom help (overrides path)
uriid Number URI ID of the help document
info-circle icon

To ensure that a custom help article is visible to all users, use the help group within your global template project.

For example, to display a small help widget showing the homepage of the PageSeeder built-in help (default):

<widget name="help" />

Or to display a medium-sized widget that can be dismissed by the user and that shows a custom help article: 

<widget name="help" size="medium">
  <parameters project="app" uriid="1234" dismissible="true"/>
</widget>