Using Help Topics
In this section:
- Documentation structure
This type of documentation is available for Ultimate edition only.
This type of documentation is available for both Ultimate and Community editions.
Both built-in and online IntelliJ IDEA documentation have similar structure, which is outlined below:
- Quick Start
This section contains all the necessary information to get started with IntelliJ IDEA:
- Guide to installing IntelliJ IDEA.
- Basic concepts part contains information about the notions that underlie the IntelliJ IDEA functionality.
- Guided tour around the UI with the descriptions of Welcome screen, menus, toolbars etc.
- Manual for the tool windows explaining how to use them.
- Guide to the editor with the detailed descriptions of the various editor-related features.
- The section Basics contains the brief overview of the main IntelliJ IDEA features, with the links to the related topics in documentation.
- In the section First Steps you can find the tutorials related to the most basic features of IntelliJ IDEA.
- The section Getting Help contains information about the various ways to learn and share.
- Finally, the page Keyboard Shortcuts You Cannot Miss contains the most often used keyboard shortcuts.
- The How-to part provides descriptions of the actions required to fulfil certain common tasks with IntelliJ IDEA. The nested Languages and Frameworks part provides important prerequisites, enabling procedures, meta procedures of working with the various frameworks, and gives some details for performing specific tasks.
- In the Reference part, find descriptions of the tool windows, dialog controls, lists of the keyboard shortcuts, information related to specific version control systems etc.
- Migration Guides
- This part contains information related to importing/exporting projects from/to Eclipse and NetBeans.
Using built-in documentation
Built-in documentation enables you to browse through the topics using the table of contents, find occurrences in the Search tab, or use the detailed Index that contains all keywords from all topics.
To bring up help contents, do one of the following
- On the main menu, choose .
- Press F1.
- Click Help button, if it is available.
To find a particular piece of information
- Click the Search tab of the help viewer.
- In the search field, type the search string and press Enter.
- In the list of topics that contain occurrences of the search string, select the desired one. Occurrences are highlighted in the right pane of the help viewer.
To find a keyword in the Index tab
- Click the Index tab of the help viewer.
- In the search field, type the desired keyword and press Enter. The caret rests at the first occurrence of the keyword. Every time you press Enter, the caret moves to the next occurrence of the keyword. To see the information about a keyword, select one of its sub-entries.
On the IntelliJ IDEA site, find online version of the IntelliJ IDEA's built-in documentation:
The online version makes it possible to find entries in the table of contents, browse documentation with the table of contents, rate topics, ask question and express your opinion. The layout of online documentation consists of:
- Table of contents pane
This pane shows the table of contents.
- Use this pane to browse through the topics.
- Click button to show or hide this pane.
- If for some reason your browser fails to show actual table of contents, refresh the page.
- Topics pane
This pane shows the topic that is currently selected in the table of contents.
- In the Keymap drop-down list, choose the platform you want to view keyboard shortcuts in (Windows/Linux, OS X etc.)
Finding a piece of information in the table of contents
- Switch to the Table of contents pane.
- In the Search IntelliJ IDEA help field, type your query.
- Press Enter.
The table contents shrinks to show the search results. Click the desired entry to show the corresponding page in the Topic pane.