- 04 May 2022
- 3 minutes to read
Using Totara Help
- Updated on 04 May 2022
- 3 minutes to read
Selecting your version
Before you start browsing the Help documentation you should check that you’re on the correct version. By default the latest version will be selected, unless you’ve bookmarked the URL for your version of Totara (e.g. https://totara.help/15).
On the home page you can change the version using the dropdown in the top-right corner.
When you are viewing an article the version dropdown will appear in the top-left corner next to the search bar.
Note that if you’re using Totara 13 or older you’ll need to go to the old Totara Help site.
The new Totara Help site uses an AI-powered search engine that allows you to search article titles, content, tags and more. You can either use the search bar on the landing page, or search when viewing an article.
The search results are sorted by relevance, and include a preview of where your search term appears. The top five results will be displayed, but you can click View all results if you can't see what you're looking for. When selecting a result, you will see the search term highlighted on the page.
On the new Help site you will find three different types of pages:
- How-to pages: These pages are short, step-by-step guides that walk you through tasks in Totara.
- Explainers: These pages outline important concepts and features in Totara.
- Reference: These pages contain comprehensive lists and tables detailing settings, available functionality, and more.
Using the page tree
If you have used the old Totara Help site you may be accustomed to using the page tree to find content. On the new site the page tree is collapsed by default, but you can expand it by clicking the arrow icon on the left-hand side of the page.
Items in the page tree with an arrow next to them are categories, which contain articles and other subcategories. You can either click the arrow to expand the category, or click the name of the category to view an index page displaying all items contained within the category. To view an article, simply click its name in the page tree.
Once you arrive on a page you can jump straight into the article content, but there are several useful features to know about. If the article contains headings you can use the table of contents in the right-hand column to go straight to a section.
You can navigate to other pages by clicking links in the article content, by expanding the page tree (see above), or by selecting an article from the Related pages section in the right-hand column. Many pages will also include a Next steps section at the bottom of the page, linking to other tasks that will logically follow on from the current article.
Under the page title you can see when the article was last updated, and an estimate of how long the page should take to read. In this section you can also click the Share button to share the article on Twitter, LinkedIn, Facebook, or by email.
Each page will have several tags, which can be viewed below the table of contents (if the page has one) in the right-hand column. You can click a tag to see other articles that share that tag. For example, if you’re viewing an article aimed at Site Administrators, you could click the Site Administrator tag to view all other articles aimed at admin users.
Rate a page
If you found a page useful, or if it didn’t help you, you may want to provide feedback on the page. Next to Was this article helpful? you can give the article a thumbs up or thumbs down. After rating the page you can optionally add a comment and click Submit. If you want us to get in touch you can also leave your name and email address.
We use these ratings and feedback to improve our documentation, so please be sure to rate any pages you find useful, or those you think could be improved.
© Copyright 2022 Totara Learning Solutions. All rights reserved.