Servoy Developer Help Wizard

Overview

The Servoy Developer Help Wizard provides comprehensive assistance to users by offering a detailed help system. This wizard includes various guides, documentation, and a search feature to help users navigate and find the information they need.

Servoy Developer Help

It has the following sections:

Search Bar

Allows users to search for specific topics within the help documentation.

• Search Field: Enter keywords or phrases to search for relevant help topics.

• Go Button: Initiates the search based on the entered keywords.

• Scope: Allows users to filter the search scope (e.g., all topics, current topic).

Left pane

This pane has 4 frames:

• Contents

• Index

• Search Results

• Bookmarks

Contents

The Contents frame in the Help - Servoy Developer wizard displays a tree view of the available help guides and documentation, organized by categories. This frame allows users to browse through the topics and select the ones they need assistance with. Here are the sections of this frame:

Buttons

Here are the available buttons:

• Print: shows the following options:

  • Print Selected Topic

  • Print Selected Topic and its Subtopics

• Search Topics: shows the following options:

  • Search Selected Topic

  • Search Selected Topic and its Subtopics

• Collapse All: Collapse all expanded categories in the tree view

• Link with Contents: Synchronizes the navigation tree with the current topic displayed in the help content

• Maximize: Maximizes the frame

Tree View

Displays the hierarchical structure of help topics, organized by categories:

• Eclipse Platform User Guide

• Eclipse Marketplace User Guide

• EGit Documentation

• SQL Explorer

Index

The Index frame in the Help - Servoy Developer wizard allows users to search for specific keywords within the help documentation. This frame helps users quickly locate topics based on indexed keywords. Here are the sections of this frame:

Buttons

Here are the available buttons:

• Maximize: Maximizes the frame

Search Field

Allows users to enter keywords or phrases to search for in the index:

• Type in the word to find: Input field where users can type the keyword or phrase they want to search for.

• Display Button: Initiates the search and displays the relevant indexed entries.

Index Entries

Displays the search results based on the keyword entered.

Search Results

The Search Results frame in the Help - Servoy Developer wizard displays the results of searches conducted within the help documentation. This frame helps users find specific topics based on their search queries. Here are the sections of this frame:

Buttons

Here are the available buttons:

• Group by categories: Groups the search results by their respective categories, providing a structured view of the results

• Show Locations: Displays / hides the locations of the search results

• Show Descriptions: Displays / hides the descriptions of the search results

• Maximize: Maximizes the frame

Bookmarks

The Bookmarks frame in the Help - Servoy Developer wizard allows users to manage their bookmarked help topics. This frame provides quick access to topics that users have marked for easy reference. Here are the sections of this frame:

Buttons

Here are the available buttons:

• Delete Selected Bookmark: Removes the selected bookmark from the list

• Delete All Bookmarks: Removes all bookmarks from the list

• Maximize: Maximizes the frame

Bookmark List

Displays the list of bookmarked topics. In order to add a bookmark, press the bookmark icon on the main toolbar while browsing a topic.

Right Pane

The right pane displays the content of the selected help topic. The example shown provides information on using the help system, including searching, synchronizing, capabilities, and keyword index.

Buttons

Here are the available buttons:

Back

Navigates through the history of viewed topics, allowing users to go back to previously viewed topics.

Forward

Navigates through the history of viewed topics, allowing users to go forward to the next topic.

Home

Returns to the home page of the help system.

Show in Table of Contents

Highlights the current topic in the navigation tree.

Bookmark Document

Adds the currently viewed help topic to the list of bookmarks for quick access.

Print

Opens a print dialog to print the currently viewed help topic.

Maximize

Maximizes the right pane.