{"action":"created","comment":{"url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/comments/231424995","pull_request_review_id":172387039,"id":231424995,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIzMTQyNDk5NQ==","diff_hunk":"@@ -0,0 +1,93 @@\n+---\n+title: Introduction to Navigation\n+---\n+\n+Objects that aggregate the \n+[Navigatable](https://github.com/JetBrains/intellij-community/blob/master/platform/core-api/src/com/intellij/pom/Navigatable.java)\n+interface can be displayed in the IDE. The role of the `Navigatable` interface is to facilitate opening an object representing content\n+in the appropriate editing or display window, and requesting focus. For example:\n+* Opening [Files, classes or symbols](https://www.jetbrains.com/help/idea/navigating-to-class-file-or-symbol-by-name.html),\n+  in an editor. This also applies to editing content in preference windows, such as \n+  [Copyright profiles](https://www.jetbrains.com/help/idea/copyright-profiles.html).\n+* Going to locations within files based on [Bookmarks](https://www.jetbrains.com/help/idea/navigating-with-bookmarks.html),\n+  [TODOs](https://www.jetbrains.com/help/idea/using-todo.html), \n+  or [Lines](https://www.jetbrains.com/help/idea/2017.3/navigating-to-line.html). \n+\n+### The Navigatable Interface \n+The [Navigatable](https://github.com/JetBrains/intellij-community/blob/master/platform/core-api/src/com/intellij/pom/Navigatable.java)\n+interface defines the following methods of particular interest:\n+\n+```java\n+\n+ boolean canNavigate();\n+\n+ boolean canNavigateToSource();\n+ \n+ void navigate(boolean requestFocus); \n+```\n+The `canNavigate()` method indicates whether this object supports navigation of any kind. The `canNavigateToSource()` method\n+indicates whether this object supports navigation to source within an editor. See the \n+[Navigatable](https://github.com/JetBrains/intellij-community/blob/master/platform/core-api/src/com/intellij/pom/Navigatable.java)\n+interface comments for more information about these two methods.\n+\n+The `navigate()` method is called to open the (content-containing) object in an editor or display, and request focus. Typically an implementation\n+of `Navigatable` does the heavy lifting of invoking an editor for the content and requesting focus. See below for examples,\n+and the [Navigatable](https://github.com/JetBrains/intellij-community/blob/master/platform/core-api/src/com/intellij/pom/Navigatable.java)\n+interface for more information.  \n+\n+### Example IntelliJ Platform Implementations of Navigatable\n+This section describes some example implementations that can be found in the IntelliJ Platform. This is by no means an exhaustive list, \n+but is intended to illustrate how `Navigatable` works in different contexts.","path":"reference_guide/navigation/navigation_intro.md","position":40,"original_position":40,"commit_id":"bd8e3174e587a8ea69d96ab81ffc2ffccde47b73","original_commit_id":"bd8e3174e587a8ea69d96ab81ffc2ffccde47b73","user":{"login":"yole","id":46553,"node_id":"MDQ6VXNlcjQ2NTUz","avatar_url":"https://avatars1.githubusercontent.com/u/46553?v=4","gravatar_id":"","url":"https://api.github.com/users/yole","html_url":"https://github.com/yole","followers_url":"https://api.github.com/users/yole/followers","following_url":"https://api.github.com/users/yole/following{/other_user}","gists_url":"https://api.github.com/users/yole/gists{/gist_id}","starred_url":"https://api.github.com/users/yole/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/yole/subscriptions","organizations_url":"https://api.github.com/users/yole/orgs","repos_url":"https://api.github.com/users/yole/repos","events_url":"https://api.github.com/users/yole/events{/privacy}","received_events_url":"https://api.github.com/users/yole/received_events","type":"User","site_admin":false},"body":"`NavigatablePsiElement` and `OpenFileDescriptor` are not \"example implementations\", these are the main two ways plugin developers will interact with navigation functionality. This particular section should have a title \"Navigating to PSI Elements\" and should say that:\r\n  * most PSI elements support navigation by implementing `NavigatablePsiElement`\r\n  * if you have a PSI element and want to navigate to it, you can usually do that by casting it to `NavigatablePsiElement` and then invoking `navigate()`\r\n  * if you implement a PSI element subclass, you usually want to support navigation for it, and you can do this by either ensuring that your base class implements `NavigatablePsiElement` or, if not, by implementing it yourself.","created_at":"2018-11-07T09:02:45Z","updated_at":"2018-11-07T09:07:13Z","html_url":"https://github.com/JetBrains/intellij-sdk-docs/pull/128#discussion_r231424995","pull_request_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/128","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/comments/231424995"},"html":{"href":"https://github.com/JetBrains/intellij-sdk-docs/pull/128#discussion_r231424995"},"pull_request":{"href":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/128"}}},"pull_request":{"url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/128","id":228777494,"node_id":"MDExOlB1bGxSZXF1ZXN0MjI4Nzc3NDk0","html_url":"https://github.com/JetBrains/intellij-sdk-docs/pull/128","diff_url":"https://github.com/JetBrains/intellij-sdk-docs/pull/128.diff","patch_url":"https://github.com/JetBrains/intellij-sdk-docs/pull/128.patch","issue_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/issues/128","number":128,"state":"open","locked":false,"title":"IJSDK-462 Navigation content for the SDK","user":{"login":"JohnHake","id":39627202,"node_id":"MDQ6VXNlcjM5NjI3MjAy","avatar_url":"https://avatars0.githubusercontent.com/u/39627202?v=4","gravatar_id":"","url":"https://api.github.com/users/JohnHake","html_url":"https://github.com/JohnHake","followers_url":"https://api.github.com/users/JohnHake/followers","following_url":"https://api.github.com/users/JohnHake/following{/other_user}","gists_url":"https://api.github.com/users/JohnHake/gists{/gist_id}","starred_url":"https://api.github.com/users/JohnHake/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JohnHake/subscriptions","organizations_url":"https://api.github.com/users/JohnHake/orgs","repos_url":"https://api.github.com/users/JohnHake/repos","events_url":"https://api.github.com/users/JohnHake/events{/privacy}","received_events_url":"https://api.github.com/users/JohnHake/received_events","type":"User","site_admin":false},"body":"New content describing navigation functionality, and OpenFileDescriptor in particular.\r\n\r\n\r\n/cc @yole  review","created_at":"2018-11-06T17:41:00Z","updated_at":"2018-11-07T09:07:13Z","closed_at":null,"merged_at":null,"merge_commit_sha":"4930cd02034d6efb7f61a060bdacd250594eb782","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/128/commits","review_comments_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/128/comments","review_comment_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/issues/128/comments","statuses_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/statuses/bd8e3174e587a8ea69d96ab81ffc2ffccde47b73","head":{"label":"JohnHake:ijsdk-462","ref":"ijsdk-462","sha":"bd8e3174e587a8ea69d96ab81ffc2ffccde47b73","user":{"login":"JohnHake","id":39627202,"node_id":"MDQ6VXNlcjM5NjI3MjAy","avatar_url":"https://avatars0.githubusercontent.com/u/39627202?v=4","gravatar_id":"","url":"https://api.github.com/users/JohnHake","html_url":"https://github.com/JohnHake","followers_url":"https://api.github.com/users/JohnHake/followers","following_url":"https://api.github.com/users/JohnHake/following{/other_user}","gists_url":"https://api.github.com/users/JohnHake/gists{/gist_id}","starred_url":"https://api.github.com/users/JohnHake/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JohnHake/subscriptions","organizations_url":"https://api.github.com/users/JohnHake/orgs","repos_url":"https://api.github.com/users/JohnHake/repos","events_url":"https://api.github.com/users/JohnHake/events{/privacy}","received_events_url":"https://api.github.com/users/JohnHake/received_events","type":"User","site_admin":false},"repo":{"id":138919783,"node_id":"MDEwOlJlcG9zaXRvcnkxMzg5MTk3ODM=","name":"intellij-sdk-docs","full_name":"JohnHake/intellij-sdk-docs","private":false,"owner":{"login":"JohnHake","id":39627202,"node_id":"MDQ6VXNlcjM5NjI3MjAy","avatar_url":"https://avatars0.githubusercontent.com/u/39627202?v=4","gravatar_id":"","url":"https://api.github.com/users/JohnHake","html_url":"https://github.com/JohnHake","followers_url":"https://api.github.com/users/JohnHake/followers","following_url":"https://api.github.com/users/JohnHake/following{/other_user}","gists_url":"https://api.github.com/users/JohnHake/gists{/gist_id}","starred_url":"https://api.github.com/users/JohnHake/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JohnHake/subscriptions","organizations_url":"https://api.github.com/users/JohnHake/orgs","repos_url":"https://api.github.com/users/JohnHake/repos","events_url":"https://api.github.com/users/JohnHake/events{/privacy}","received_events_url":"https://api.github.com/users/JohnHake/received_events","type":"User","site_admin":false},"html_url":"https://github.com/JohnHake/intellij-sdk-docs","description":"IntelliJ SDK Platform Documentation","fork":true,"url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs","forks_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/forks","keys_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/teams","hooks_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/hooks","issue_events_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/issues/events{/number}","events_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/events","assignees_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/assignees{/user}","branches_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/branches{/branch}","tags_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/tags","blobs_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/languages","stargazers_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/stargazers","contributors_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/contributors","subscribers_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/subscribers","subscription_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/subscription","commits_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/contents/{+path}","compare_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/merges","archive_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/downloads","issues_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/issues{/number}","pulls_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/labels{/name}","releases_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/releases{/id}","deployments_url":"https://api.github.com/repos/JohnHake/intellij-sdk-docs/deployments","created_at":"2018-06-27T18:38:11Z","updated_at":"2018-11-06T19:08:56Z","pushed_at":"2018-11-07T01:54:17Z","git_url":"git://github.com/JohnHake/intellij-sdk-docs.git","ssh_url":"git@github.com:JohnHake/intellij-sdk-docs.git","clone_url":"https://github.com/JohnHake/intellij-sdk-docs.git","svn_url":"https://github.com/JohnHake/intellij-sdk-docs","homepage":"http://www.jetbrains.org/intellij/sdk/docs/","size":19305,"stargazers_count":0,"watchers_count":0,"language":"Java","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"JetBrains:master","ref":"master","sha":"1cd2279bf7863f6e6b77c0f12a22545a5279943e","user":{"login":"JetBrains","id":878437,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg3ODQzNw==","avatar_url":"https://avatars2.githubusercontent.com/u/878437?v=4","gravatar_id":"","url":"https://api.github.com/users/JetBrains","html_url":"https://github.com/JetBrains","followers_url":"https://api.github.com/users/JetBrains/followers","following_url":"https://api.github.com/users/JetBrains/following{/other_user}","gists_url":"https://api.github.com/users/JetBrains/gists{/gist_id}","starred_url":"https://api.github.com/users/JetBrains/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JetBrains/subscriptions","organizations_url":"https://api.github.com/users/JetBrains/orgs","repos_url":"https://api.github.com/users/JetBrains/repos","events_url":"https://api.github.com/users/JetBrains/events{/privacy}","received_events_url":"https://api.github.com/users/JetBrains/received_events","type":"Organization","site_admin":false},"repo":{"id":27145735,"node_id":"MDEwOlJlcG9zaXRvcnkyNzE0NTczNQ==","name":"intellij-sdk-docs","full_name":"JetBrains/intellij-sdk-docs","private":false,"owner":{"login":"JetBrains","id":878437,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg3ODQzNw==","avatar_url":"https://avatars2.githubusercontent.com/u/878437?v=4","gravatar_id":"","url":"https://api.github.com/users/JetBrains","html_url":"https://github.com/JetBrains","followers_url":"https://api.github.com/users/JetBrains/followers","following_url":"https://api.github.com/users/JetBrains/following{/other_user}","gists_url":"https://api.github.com/users/JetBrains/gists{/gist_id}","starred_url":"https://api.github.com/users/JetBrains/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JetBrains/subscriptions","organizations_url":"https://api.github.com/users/JetBrains/orgs","repos_url":"https://api.github.com/users/JetBrains/repos","events_url":"https://api.github.com/users/JetBrains/events{/privacy}","received_events_url":"https://api.github.com/users/JetBrains/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/JetBrains/intellij-sdk-docs","description":"IntelliJ SDK Platform Documentation","fork":false,"url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs","forks_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/forks","keys_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/teams","hooks_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/hooks","issue_events_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/issues/events{/number}","events_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/events","assignees_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/assignees{/user}","branches_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/branches{/branch}","tags_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/tags","blobs_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/languages","stargazers_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/stargazers","contributors_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/contributors","subscribers_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/subscribers","subscription_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/subscription","commits_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/contents/{+path}","compare_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/merges","archive_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/downloads","issues_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/issues{/number}","pulls_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/labels{/name}","releases_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/releases{/id}","deployments_url":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/deployments","created_at":"2014-11-25T20:59:00Z","updated_at":"2018-11-06T01:25:43Z","pushed_at":"2018-11-06T17:41:01Z","git_url":"git://github.com/JetBrains/intellij-sdk-docs.git","ssh_url":"git@github.com:JetBrains/intellij-sdk-docs.git","clone_url":"https://github.com/JetBrains/intellij-sdk-docs.git","svn_url":"https://github.com/JetBrains/intellij-sdk-docs","homepage":"http://www.jetbrains.org/intellij/sdk/docs/","size":18944,"stargazers_count":449,"watchers_count":449,"language":"Java","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":283,"mirror_url":null,"archived":false,"open_issues_count":4,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":283,"open_issues":4,"watchers":449,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/128"},"html":{"href":"https://github.com/JetBrains/intellij-sdk-docs/pull/128"},"issue":{"href":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/issues/128"},"comments":{"href":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/issues/128/comments"},"review_comments":{"href":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/128/comments"},"review_comment":{"href":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/pulls/128/commits"},"statuses":{"href":"https://api.github.com/repos/JetBrains/intellij-sdk-docs/statuses/bd8e3174e587a8ea69d96ab81ffc2ffccde47b73"}},"author_association":"COLLABORATOR"}}
{"actor":{"display_login":"yole"}}