Share:
ClickHelp Documentation

Info and Warning Boxes

Information and Warning Boxes are often used in documentation to draw a reader's attention to some crucial piece of data.

Watch this video to learn how to add and style such elements in ClickHelp:

Adding Info and Warning Boxes 

To insert an Information  or a Warning Box :

  • Place the text cursor where you want the element to be added to your topic.
  • Find the desired box in the Boxes section of the Insert tab. 
     
  • Click the needed element, and it will appear in the topic.
     
  • Delete the default text.
  • Write the text of your own.

Information Boxes are added to topics in the same way.

Customizing Info and Warning Boxes

Each time you create a project from a template, a project folder appears in the your File Storage. This folder contains style files, script files, some template-related images. Info Box and Warning Box icons are also stored there by default. 

For example, for a project called User Guide, these icons will have the following paths:

Storage\project-user-guide\info.png

Storage\project-user-guide\warning.png

If you want to have a custom icon for these boxes, just replace this files with you own images leaving the name and location the same. 

Warning Make sure that you neither move, rename nor delete these icons in the project folder in File Storage.

If the icons are missing from their default location, nothing will be copied to the publication, and the Information and Warning boxes will be corrupted.

Restoring Missing Icons from Template

In case you have accidentally deleted the icons, you can restore the default images by copying them from the template you've used for your project. Follow the steps below:

  • Launch the File Manager via clicking the File Manager... main menu icon.
  • Go to Storage\Templates\Projects\**name-of-the-template-you-used**\
  • Hover over the info.png icon and enable the check-box in the top-right corner.

  • Enable the checkbox for the warning.png icon, as well.
  • Click the Copy button at the File Manager toolbar.

  • Select your project folder: Storage\**your-project-name**\
  • Click Ok to copy the files.
  • In case you have already created a publication with the icons missing, publish the project again in Update mode to overwrite the existing publication.  

Using this approach, you can restore/modify the info and warning boxes in your ClickHelp projects.