Help Page

Provides an interactive interface for browsing, searching, and reading Grooper help topics.

Remarks

The Help Page is the central resource for accessing Grooper documentation and help topics within the web client.

Layout and Components

• Topic Tree:
  Displays a hierarchical list of available help topics using the Topic Tree control. Users can browse categories and select specific topics to view detailed documentation.
• Search Bar:
  Allows users to search help topics by keyword, namespace, substring, or regular expression. The search supports advanced filters such as ns:namespace, quoted substrings, and regex patterns (see the 'SearchTooltip' property for usage tips).
• Content Viewer:
  Shows the full documentation for the selected topic, including summaries, remarks, and links to related topics. The viewer supports highlighting of search terms and navigation between topics.
• Navigation Buttons:
  Includes 'Back' and 'Forward' buttons for moving through the user's topic navigation history.

User Interactions

• Browse the Topic Tree to explore available help topics and categories.
• Use the search bar to quickly locate topics of interest, leveraging advanced search syntax for precise results.
• Select a topic to view its documentation, including code samples, property descriptions, and related links.
• Use the navigation buttons to move backward and forward through previously viewed topics.

Additional Notes

• The Help Page is context-aware and may highlight or pre-select topics based on the user's current location in the application.
• The help content is dynamically loaded from the repository and may include links to other topics, external resources, or documentation pages.
• The page is designed for both new and experienced users, providing comprehensive reference material and usage guidance for all Grooper features.

Command Buttons

Button	Shortcut Key		Summary
arrow_circle_left back			Go back to the previous topic.
arrow_circle_right forward			Go forward to the next topic.
database repository		►	Connect to a different repository. This button will open the "Change Repository" dialog box. The Object List of this dialog box will be populated by connections to Grooper repositories established in GCC (Grooper Command Console). Selecting an entry other than the current active repository and pressing the OK button will change the environment you are viewing and interacting with for all Grooper pages to the newly selected repository.
account_circle user_info			Display user information and setting management functions.
dark_mode dark_mode			Toggle between dark and light mode.
help help		►	Display help. This button will open a new tab in your browser pointed at Grooper Help. The destination within the Grooper Help page will change depending on what object you have selected in the Tree Viewer.