Versions Compared

Old Version 15

changes.mady.by.user Kseniia Emelianova

Saved on

compared with

New Version Current

changes.mady.by.user Kseniia Emelianova

Saved on

Key

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

...

  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 Manager.

    1. Add the quick start document to the document in Manager. Add all the translations needed.

  3. Set meta data on the document in 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

    Code Block
    // These changes are no longer needed in profile.config,
// as they are moved to configurable-property-values.config and are editable via the administrator UX)
//  <QuickStartGuideEnabled>true</QuickStartGuideEnabled>
//   <QuickStartGuideNextPreviousButtonEnabled>true</QuickStartGuideNextPreviousButtonEnabled>
//   <QuickStartGuideDocument identity="quicktips"/>     or     <QuickStartGuideDocument label="quicktips"/>

  6. Login to the Web Viewer as Administrator, go to the user dropdown menu to select Administrate, select Configuration, and scroll down to select Introduction

    administrate.png

    configuration.png

  7. In the Introduction settings, tick checkbox QuickStartGuideEnabled to enable the Quick Start Guide, Specify the QuickStartDocument name and Identity ( “quicktips - Help” in our case), and tick the QuickStartGuideNextPreviousButtonEnabled if you are using an HTML page which consists of several subpages (note that this setting does not need to be enabled if your guide is a PDF document).

    intro.png

  8. Save changes and check if Quick Tips the “Quick Tips” option has appeared in the user dropdown menu

    QuickTips.png


...