Skip to main content

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.

Selves

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

drawing-4-1685088789.png
1 Search field

You can search the entire document for keywords. See Keyword Search for more information.

2 Select button

You can select the content view style from Shelves or Books.

3 API document button

By clicking this button, a new window will open to display API documents.

4 Recent Views

Shelves, Books, and Chapters/Pages that you have viewed in the past will be listed. See Recent Views for details. 

5 Content display area

Contents are displayed. When you navigate to a page, you will see the document.

6 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.

7 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.


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. 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.


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.

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.