Using Synergy Help

Synergy help files can be opened using the button in the top toolbar.

What is Synergy Help?

Synergy Help provides additional information about each function or list screen. Synergy Help is context sensitive, which means the help will automatically open to the topic that relates to the function you are using. The help is designed to explain what the function is, why you should use it, and what actions are available on each screen. Use the links in the want to learn more section to navigate to topics for related functions.

Why use Synergy Help?

Learn more about how to use each of the Synergy functions. Each topic will also describe what actions are available on each screen, and what each of the columns and fields are used for in Synergy.

Actions available

Return to the Home Menu

1. The 'Home' button is located in the help toolbar, which is shown at the top of the topic.
2. Click the 'Home' button to load the main navigation menu for the Synergy help files.

Expand / Collapse

1. The 'Expand all' button will expand all text within the open topic. This is located in the top toolbar above the help topic. This allows you to read the entire topic, or print the entire contents of the topic.
2. The 'Expand Section' button within the topic, will expand just that section of the topic. This allows you to only read the sections of the topic you are interested in learning more about.
3. The 'Collapse all' button will be shown after you have used the 'Expand all' feature. This will collapse all the grouped text in the topic. This is located in the top toolbar above the help topic.
4. The 'Collapse Section' button within the topic will collapse just that section of the topic. This button is only shown after the text has been expanded.

Expand Text / Collapse Text

1. The 'Expand Text' and 'Collapse Text' buttons are shown in the 'Columns available' or 'Fields available' sections of the help topics.
2. View these options using the 'Expand Section' button to view more information about the columns or fields.
3. 'Expand Text' button will open the column/field definition, so that you can see the purpose of the column/field.
4. 'Collapse Text' button will hide the column/field definition.

Search

1. The search box is located in the toolbar shown at the top of the help topic.
2. Type a 'keyword' into the 'Search' field.
3. Press enter to run the search. The results will take a few moments to be displayed.
4. The search results will be shown in the list, in a similar style to a 'Google' search.
5. The search results display the topic title, a topic description, and the link to the topic.
6. These results are ranked to display the topics which contain the 'keyword' most often at the top of the list.
7. Click on a search result in the list, to open that topic.

Open the 'Full Page' view of the help files

1. The 'Full Page View' button is located in the help toolbar, which is shown at the top of the topic.
2. Click the 'Full Page' button to open the help files in a new web browser.
3. 'Full Page' view help will be displayed using your entire web browser size, to make detailed help topics easier to read.
4. Use the 'Full Page' view help when you want to print a topic, or browse the table of contents.

Using the Table of Contents in the 'Full Page' help view

1. The table of contents is only available in the 'Full Page' help view.
2. Click the 'Full Page View' button in the help toolbar.
3. The table of contents is shown on the left side of the screen by default.
4. Use the table of contents to:
   1. Grouping of topicsThe topics are stored within groups to show all of the topics about the same function together. Click on a group name to expand the list of topics, or to see any additional sub groupings of topics.
   2. Open a topicClick on a topic in the contents panel, to open the topic and read more.
   3. Close the Contents panelTo open and close the contents panel, a toggle button is located in the middle of the panel. Click on the arrow button to open or close the contents panel. This panel is not included in the print output.

Print the open topic

1. Click the 'Full Page View' button in the help toolbar, which is shown at the top of the topic.
2. 'Full Page' help will then be shown in a new tab in your web browser.
3. Open the topic you want to 'Print' using the 'Table of Contents' or by 'Searching' for the topic.
4. When the topic is open, click the 'Expand All' button shown in the top toolbar for the topic. This will expand all the text in the help topic, to ensure that it is included in your print out.
5. Click the 'Print' button in the top toolbar, which is shown in the top toolbar for the topic.
6. Follow the prompts to print the topic.

Want to learn more?

Looking for more help? Try reviewing the following topics: View Topics

© 2015 Total Synergy Pty Ltd

Open topic with navigation