Main page responsive layout
The Main Page is the home page generated in the WebHelp Responsive output. The main function of the home page is to display top level information and provide links that help you easily navigate to any of the top level topics of the publication. These links can be rendered in either a Tiles or Tree style of layout. The main page also consists of various other components, such as a logo, title, menu, search field, or index link.
Main Page - Tiles Layout
In the tiles presentation mode, a tile component is created for each chapter (first level topic) in the publication. The tile presents a link to the topic and its short description.
Main Page - Tree Layout
In the tree presentation mode, links to the first and second level topics in the publication are displayed using a tree-like component.
Main Page Components
The layout components displayed in the main page are:
- Publication Title
- The title of the publication. It is usually taken from the DITA map title.
- Logo
-
Displays a logo associated with the publication. Additionally you can set a target URL that will be opened when you click on the logo image.
The logo image can be specified using the
webhelp.logo.image
transformation parameter. For target URL use thewebhelp.logo.image.target.url
parameter. - Helps you to navigate to your documentation. This component presents a set of links to all topics from your publication. For information about customizing the menu, see topic.
- Index terms link
- Presents a link to the index terms page. You can control if this
component is displayed by using the
webhelp.show.indexterms.link
parameter. - Search query input
- Input text field allowing you to easily enter your search queries.
- Tiles area
- This section contains a tile for each root topic of the published documentation.
- Topic Tile
- A tile associated with a main topic. Each topic tile has three sections that corresponds to the topic title, short description, and image.
- Topic Tile Title
- Presents the navigation title of the associated topic.
- Topic Tile Short Description
- Presents the short description of the topic. It may be collected either from the topic or from the DITA map topic meta.
- Topic Tile Image
- Presents an image associated with the topic. The image association is done in the DITA map.
- Tree area
- An area containing topic titles from first and second level of your publication.
- WebHelp Responsive output footer.