Creating guides for your apps

This topic refers to functionality that is not available to accounts on the Quick Base Essential plan. If the functionality described here does not match what you're seeing in Quick Base, your account is probably on this plan.

You can help users by providing guides to your app that appear in the Quick Base help menu:

To add guides to the Quick Base help menu:
  1. Create your guides directly within Quick Base as rich text pages.

    Tip: Instead of creating guides inside Quick Base, you can also point to external web pages by adding a single meta refresh tag to each rich text page. When users click the link, they a redirected the web page you specify. Here is the example code:

    <meta http-equiv="refresh" content="0;URL=https://www.example.com/"  />
  2. From the app home page, click Settings, then click App properties.

  3. Click Branding. In the Custom help section you can define up to three guides.

  4. Complete the following tasks to create your guide:

  1. Type a name for your guide in the Title box. This is the name users see and click to access your guide. So, do your best to make it helpful and descriptive.

  2. Click the Links to drop down and select the page you created to serve as a guide.

    This page name should end in .html to identify the application page that contains the guide.

  3. Type additional information about the guide in the Description box.

    This is especially important if you create multiple guides for different audiences. Use the description to help users understand which guide to choose and what content is in each.

  4. Click Save.

    Your end users see the titles for each guide you enter at the top of the help menu. When users click a guide's title, it opens in a new browser window.

Related topics: