Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide shows how to create a custom quick start guide in html in Assert Web Viewer. The quick start guide will be available when a user visits Assert Web Viewer for the first time and in the menu.

...

Follow these steps to add a quick start file to AssertWeb Viewer.

  1. Create an html file for the quick start guide. The file will need to follow the sample format below.
    1. Each <div id="div1" class="container"> will become one page in the quick tip guide.
    2. Images can be used in the html file, but they will need to be referred using a specific syntax as described below and placed in a sub folder called Documents/Content.
  2. Create a new document in Assert Manager.
    1. Add the quick start document to the document in Assert Manager. Add all the translations needed.
  3. Set meta data on the document in Assert Manager.
    1. Set Label="quicktips" or Identity="quicktips".
    2. Name that allow search, e.g. "Quick tips"
    3. Add specifications that are searchable but not visible to make the document searchable. E.g. add "Help" as a specification.
    4. Ensure to set mode as "IncludeInPublish" to ensure the document is included at publish despite not being added to a catalogue.
  4. Manually copy images used in the html to the site. The images shall be placed in this folder <site>/Documents/Content/ on the editor server.
  5. Update profile.config to enable quick start guide

...

It is also possible to add a pdf-based quick start guide. If this is the case, follow this procedure.

  1. Add the document to Assert Manager and set metadata according to step 2 and 3 above.
  2. Update the profile.config according to step 5 above, but omitt the QuickStartGuideNextPreviousButtonEnabled tag since it cannot be used in a pdf.

...