RubyMine 7.0.1 Web Help

4.0+

View | Tool Windows | TODO

RubyMine scans your project for comments in the source code that match the TODO patterns defined in the TODO dialog and displays results in the TODO tool window.

The TODO tool window consists of following tabs:

  • Project tab that show the TODO items for the whole project.
  • Current File tab.
  • Scope Based tab that enables viewing TODO items pertaining to a certain scope, selected from the drop-down list, and ignoring the other items.
  • Current Changelist, if version control is enabled.

This tool window helps you view, sort and group the TODO items in a convenient way, navigate to the source code and keep fixes under the version control.

In this section:

Toolbar buttons

Item Tooltip and shortcut Description
arrowUp Previous TODO
Ctrl+Alt+UpShift+Alt+UpCtrl+Alt+UpCtrl+Alt+UpCtrl+Alt+UpCtrl+Alt+UpAlt+UpCtrl+Alt+UpCtrl+Shift+UpAlt ⌘ UpAlt ⌘ UpAlt ⌘ UpAlt ⌘ Up
Navigate to the previous TODO item.
arrowDown Next TODO
Ctrl+Alt+DownShift+Alt+DownCtrl+Alt+DownCtrl+Alt+DownCtrl+Alt+DownCtrl+Alt+DownAlt+DownCtrl+Alt+DownCtrl+Shift+DownAlt ⌘ DownAlt ⌘ DownAlt ⌘ DownAlt ⌘ Down
Navigate to the next TODO item.
help.gif Help
F1F1F1F1F1F1F1F1F1ContextHelpF1ContextHelpF1
Use this icon or shortcut to open the corresponding help page.
img
img
Expand all
Ctrl+NumPad+ or Ctrl+EqualsCtrl+NumPad+ or Ctrl+EqualsCtrl+NumPad+ or Ctrl+EqualsCtrl+NumPad+ or Ctrl+EqualsCtrl+NumPad+ or Ctrl+EqualsCtrl+NumPad+ or Ctrl+EqualsCtrl+NumPad+ or Ctrl+EqualsCtrl+NumPad+ or Ctrl+Equals⌘+NumPad+ or ⌘+Equals⌘ NumPad or ⌘ Equals⌘ NumPad or ⌘ Equals⌘ NumPad or ⌘ Equals⌘ NumPad or ⌘ Equals
Collapse all
Ctrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+MinusCtrl+NumPad - or Ctrl+Minus⌘+NumPad - or ⌘+Minus⌘ NumPad - or ⌘ Minus⌘ NumPad - or ⌘ Minus⌘ NumPad - or ⌘ Minus⌘ NumPad - or ⌘ Minus
Click this button to have all nodes expanded or collapsed.
img Autoscroll to Source Toggle the Autoscroll to source mode. When this button is pressed, every time the node is focused, the corresponding line of source code is highlighted in the editor.
commonfilter Filter TODO items Click this button to select the desired filter from the list, or invoke the TODO dialog and edit the list of TODO patterns and filters as required.

filterTodoList

previewUsages Preview Usages If this button is pressed, a pane to the right shows the source code of the selected file, with the corresponding TODO item highlighted.

Tip

The following buttons are available in the Project and Scope Based tabs.

img Ctrl+DCtrl+DCtrl+DCtrl+D⌘+DCtrl+DCtrl+D, Ctrl+Shift+Down or Ctrl+Shift+UpCtrl+DCtrl+Shift+D⌘ D⌘ D⌘ D⌘ D If this button is pressed, the TODO items show under the corresponding module or library node.
img Ctrl+PCtrl+PCtrl+PCtrl+PCtrl+PCtrl+PCtrl+PCtrl+P⌘+P⌘ P⌘ P⌘ P⌘ P If this button is pressed, the TODO items show under the corresponding packages.
img Ctrl+F or Alt+F3Ctrl+F or Shift+Alt+3Ctrl+F or Shift+Alt+3Ctrl+F or Alt+F3Ctrl+Alt+S, Alt+F3 or Ctrl+SCtrl+F or Alt+F3Ctrl+F or Alt+F3Ctrl+F or Alt+F3⌘+F or Alt+F3⌘ F⌘ F or Alt F3⌘ F⌘ F or Alt F3 If this button is pressed, the TODO items show as a flat list. Thus, if a package is somewhere deep within your project, you do not need to dig deep into the hierarchy.

Context menu commands

Item Keyboard Shortcut Description
Jump to Source F4F4F4F4F4F4F4F12 or Ctrl+Shift+EF4⌘ Down or F4F4F3F4 Navigate to the selected usage in the source code.
Local History Show Local History submenu for the selected search result. Refer to the Local Version Control procedures for details.
<VCS> Show menu of the VCS, associated with the directory. See Version Control Procedures and Reference for details.

Title bar context menu and buttons

The title bar context menu provides the options for controlling the tool window viewing modes. It also contains the commands for associating the tool window with a different tool window bar, resizing and hiding the tool window.

To access the menu, right-click the window title bar.

Note that most of the menu options may alternatively be accessed by means of the title bar buttons.

Toolbar icon Context menu command Description
viewMode Pinned, Docked, Floating, Split Mode These options let you control general appearance and behavior of the tool window, see Viewing Modes.
Move to To associate the tool window with a different tool window bar, select this command, and then select the destination tool window bar (Top, Left, Bottom or Right).
Resize To resize the tool window by moving one of its borders, select this command, and then select the necessary Stretch to option.

Note that this command is not available in the floating mode.

hideSide
Shift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift+EscapeShift EscapeShift EscapeShift EscapeShift Escape
Hide Use this command to hide the tool window.

Tip

When used in combination with the Alt key, clicking this button hides all the tool windows attached to the same tool window bar.

See Also

Concepts:

Procedures:

Reference:

Getting Started:

Web Resources: