Menu

Topics

Using Documentation

There's a lot of great information in the Avoka Transact Documentation web site and many ways to find it. This topic explains how the documentation is structured and how you can explore it to find what you need.

If this is your first visit to the documentation, we suggest you reading through all of the topics in the Getting Started section.

Navigation

There's a number of ways to navigate the Avoka Documentation web site.

At the top of the page, the menu bar provides quick access to top-level sections of the documentation.

On the left side of the page, the Topics menu provides a table of contents for all topics in the documentation. There's a lot of topics listed here, but you can expand or collapse each section to control what's displayed.

To hide or show the topics list, click the Show/Hide Table of Content button on the tool bar.

The tool bar also includes a Back button that returns you to the previous page and buttons that allow you to share the page via social networks or email.

The search feature is the most flexible way to find what you need. Type what you're looking for in the Search box and press Enter to search everywhere on Avoka's Documentation and Community web sites.

From the search results page, you can limit your search to just the Community or Documentation web site.

On the right side of the page, the Quick Menu provides direct access to some common locations, including the forums, blogs, and how-to articles on the Avoka Community web site, the Avoka e-Learning and Support web sites, and the home page of the Avoka documentation.

Links to these locations, along with others, are also available in the page footer.

Topics

The documentation is organized as self-contained topics designed to minimize repetition across pages and ensure there's a single source of truth for every concept and feature.

Every topic begins with a title that lets you know what you're looking at. Links between topics let you jump straight to related content. Many topics include a row of badges above the content that provide information about the topic, including:

  • products the topic relates to
  • roles the topic is relevant for
  • software versions the topic is compatible with

For example, the image below shows that the Maestro Libraries Overview topic relates to the Maestro product, is relevant for Form Builders, and has been updated with content for Maestro v18.05.

Your Feedback

Every page has a Feedback button that makes it easy to provide feedback about how we can improve the content.

To provide feedback:

  1. Click Feedback.
  2. Select a rating.
  3. Type your comments in the text field that appears.
  4. Optionally, click the icon in the bottom-left corner of the text field to highlight an area of the screen. This is useful if there's a specific issue you'd like to show us.
  5. Click Send.