Document usage

This section describes how to use this document (CGI Studio Documentation).

Structure of this document

This document consists of the following four levels.

Shelves	This is a large classification. It corresponds to the role of bookshelves in a library.
Books	This is a middle classification within the large category. It corresponds to the role of books arranged in the bookshelf, which is a large classification.
Chapters	This is a small classification that bundles the Pages placed in the Books, a middle classification.
Pages	This is an actual document is described. Pages are classfied according to its usage by Chapters/Books/Shelves.

When this manual is launched, a list of Shelves is displayed, and from Shelves, you can navigate to Books and Chapters/Pages as child hierarchies to browse the desired document.

User Interface

1	CGI Studio Documentation	CGI Studio Documentation icon.button. Clicking this iconbutton will take you to the Shelves screen.
2	Search field	You can search the entire document for keywords. See Keyword Search for more information.
3	Select button	You can select the content view style from Shelves or Books.
4	API document button	By clicking this button, a new window will open to display API documents. Note that this button will not be displayed if the API documentation is not avairable (a blank page will be displayed when you click the link to the API documentation item in the documentation).
5	Back/Forward	Click this button to go backward or forward in the displayed content. See Document navigation for more information.
6	Contents search	Performs a keyword search on the text currently displayed on the offline document screen. Search results are highlighted in yellow. See Contents search for more information.
7	Bookmark registration icon button	When any content (Shelves/Books/Chapters/Pages) is displayed, click this iconbutton to add a displayed content to the Bookmark. When Bookmark is registered, the button turns blue.
8	Recent Views	Shelves, Books, and Chapters/Pages that you have viewed in the past will be listed. See Recent Views for details.
9	Content display area	Contents are displayed. When you navigate to a page, you will see the document.
10	Sort	Items displayed in the contents display area can be sorted by any criteria. The sorting conditions can be selected from "Name", "Created Date", and "Updated Date". You can also switch the sort order from descending to ascending by clicking the up/down arrows on the right side of the pull-down menu.
11	Actions	Switches the display style in the contents display area to List or Grid view. This section is displayed only when display Shelves or Books.
12	Bookmark	Items registered using the Bookmark registration iconbutton will be displayed.
13	Scroll up button	It will appear automatically when you scroll down the displayed content. Scroll up to the top of the page by clicking this button.

Document navigation

Except in particular cases, Sleves is usually displayed. Navigate by clicking on the title of Books and Chapters/Pages to be viewed, in that order. 

Scroll up button/Home Key operation

When viewing a document, press Scroll up button displayed in the lower right corner of the screen, or the Home key to go to the beginning of the currently displayed page. This will make it easier to access Breadcrumb, Back/Forward buttons and the Search field.

Bookmark

By clicking on the Bookmark registration icon,button, you can register the currently displayed content in the Bookmark field. If the currently displayed content is not yet registered as a bookmark, its color is gray. When the content is registered (by clicking on the Bookmark registration icon)button), the color changes to blue.

Breadcrumb

When you move through the hierarchy, the path to the current display location is shown at the top of the content display area. To go back in the hierarchy, click on this path.

Recent Views

When you return to Shelves, your browsing history will be displayed on the left side of the screen, showing the books/chapters/pages you have moved to. By clicking anywhere in there, you can move to the target location. You can delete the entire browsing history by clicking the [ CLEAR ] button at the bottom of Recent Views.

Page Navigation/Book Navigation

On Pages view, Page Navigation/Book Navigation is displayed on the left side of the screen.

• • • • • Page Navigation displays a list of headings on the currently displayed page. By clicking on any heading, the article will move to the corresponding location.
        • Book Navigation displays a list of other Chapters/Pages in the book that contains the currently displayed page. Clicking on any Chapters/Pages title also switches the display to the corresponding location.

By moving the mouse cursor over the page body or Page Navigation/Book Navigation, the display can be scrolled up and down respectively.

Back/Foward

By clicking the "Back/Forward" button in the upper right corner of the screen, you can go back or forward through the content displayed on the screen based on your viewing history.

Keyword Search

You can search for keywords by entering any string of text in the search field at the top of the document and pressing the Enter key. Up to 10 search results will be displayed. If there are more than 10 results, click the [ MORE RESULTS ] button at the bottom of the search results screen to display them.

Content Type

Keyword searches are performed for all categories (Page/Chapter/Book/Shelf). Therefore, you can narrow down your search to only those results that belong to the target category by re-selecting the category from the [ Content Type ] field displayed on the left side of the search results screen and clicking [ UPDATE SEARCH ].

 

Contents search

Search for keywords in the displayed contents. As you enter keywords, the keywords you entered will be highlighted in yellow (all text in the screen will be searched for).

• Pressing the Enter key moves the input keywords (keywords that are currently displayed are highlighted in orange).
• Press Shift+Enter to move the input keywords in reverse order.
• Press Ctrl+F to move to the content search field.

How to Download Video Data

Tutorial Videos chapter allows you to watch each tutorial video.
If you have issues with the video playback, you can download the video by clicking on the orange frame in the figure below and select "Download" from the menu that appears. 

Feedback

At the bottom of each page is a feedback function. You can send us your comments directly about the content of the pages, such as the one below.

• The description was very clear.
  
• The description was not clear enough for me to understand the details of the feature or how to use it.

You can submit your feedback by following the steps below.

1. At the bottom of the page, click the "Yes" or "No" button to the right of "Was this page helpful?
2. The "Tell us more" area (shown in the yellow area below) will appear.
3. In the text entry area, enter your opinion on whether or not you found the information useful.
4. Click the "Submit Feedback" button at the bottom of the text entry area.
   • Your feedback will be sent to Candera. 
5. The currently displayed feedback input area will disappear.
   • If successful, the message "Thank you for your feedback" will be displayed.
   • Otherwise, "Sorry, connection to the server timed out." will appear if it cannot connect to the server.

Callouts

In this document, statements that require special attention are indicated by the following two types.

Use for an information that should be conveyed incidentally in operations and configurations.

Use for an information that should be required an attention in operations and its configurations.