Skip to content

Commit 30f278b

Browse files
committed
Included links to the wikis for Java notebooks guide and VS Code tips.
Also added minor formatting fixes similar to previous changes.
1 parent a82ffa5 commit 30f278b

File tree

1 file changed

+34
-42
lines changed

1 file changed

+34
-42
lines changed

README.md

Lines changed: 34 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,12 @@ Java Platform extension from Oracle brings full featured development support (ed
3232

3333

3434
## Getting Started
35-
1. VS Code Tips
36-
- To install and update extensions refer to [extensions](https://code.visualstudio.com/docs/getstarted/extensions).
37-
- Search for a command by opening the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and typing the keywords.
38-
- Keyboard Shortcut:
39-
- Windows/Linux: `Ctrl+Shift+P`
40-
- macOS: `Shift+Command+P`
41-
- Type `>` in the search bar at the top.
42-
- User input box opens at the top whenever input is required.
35+
1. See the [VS Code Tips](https://github.com/oracle/javavscode/wiki/VSCode-Tips) wiki for a quick primer on getting started with VS Code.
4336
2. Setting up the JDK
4437
- If no JDK is present in your system then the extension can set things up for you. For more details refer to [JDK Downloader](#jdk-downloader) section.
45-
- Set the JDK in the `Open Settings | Jdk: Jdkhome` setting to point to the JDK that the Language Server will run on and also by default use for running and compiling projects.
38+
- Set the VS Code `Settings | Jdk: Jdkhome` setting to point to the JDK that the Language Server will run on and also by default use for running and compiling projects.
4639
- The extension requires JDK 17 or newer to run.
47-
- Optionally, set a different JDK to compile and run projects in the `Open Settings | Jdk › Project: Jdkhome` setting.
40+
- Optionally, set a different JDK to compile and run projects in the `Settings | Jdk › Project: Jdkhome` setting.
4841
- By default, the __jdk.jdkhome__ setting is used.
4942
- Projects can run on JDK 8 and above.
5043
- For more information, see the section [Selecting the JDK](#selecting-the-jdk).
@@ -77,40 +70,40 @@ Project Explorer provides an overview of logical project structure, groups sourc
7770

7871
## Interactive Java Notebooks
7972
### Introduction
80-
* Experience interactive coding with Java notebooks.
81-
Use the __Java: Create New Notebook...__ command to create a new Java notebook(`.ijnb` file)
82-
![Java Notebook](vscode/images/java_notebook.gif)
83-
* Add code snippets with `+ Code` button and document with markdown cells with `+ Markdown`.
84-
* Double click on a cell to edit and hit `Esc` when done.
85-
* Jupyter-style notebooks let you combine Java code snippets with markdown-formatted text cells.
86-
* Run individual code cells or execute the entire notebook.
87-
* Can save outputs alongside code cells.
88-
* Sharing notebooks
73+
* Experience interactive coding with Java notebooks. See the [Using Interactive Java Notebooks](https://github.com/oracle/javavscode/wiki/Interactive-Java-Notebooks) wiki for guidance and tutorials on using notebooks.
74+
* Use the __Java: Create New Notebook...__ command to create a new Java notebook(`.ijnb` file)<br/>
75+
![Java Notebook](vscode/images/java_notebook.gif)
76+
* Add code snippets with `+ Code` button and document with markdown cells with `+ Markdown`.
77+
* Double click on a cell to edit and hit `Esc` when done.
78+
* Jupyter-style notebooks let you combine Java code snippets with markdown-formatted text cells.
79+
* Run individual code cells or execute the entire notebook.
80+
* Can save outputs alongside code cells.
81+
* Sharing notebooks
8982
* Share as `.ijnb` files for use with Oracle Java extension.
9083
* Rename with `.ipynb` for viewing in other IDEs Jupyter etc.
91-
* Download the [sample notebooks](https://github.com/oracle/javavscode/blob/main/samples/notebooks) and open in VSCode to get started.
84+
* Download the [sample notebooks](https://github.com/oracle/javavscode/blob/main/samples/notebooks) and open in VS Code to get started.
9285

9386
### Java Notebooks for Java Projects
94-
* Document Java projects with interactive Java notebooks.
95-
* Open/Create a Java notebook in your workspace folder loaded with classes from your project.
87+
* Document Java projects with interactive Java notebooks.
88+
* Open/Create a Java notebook in your workspace folder loaded with classes from your project.<br/>
9689
![Java Notebook For Project](vscode/images/project_notebook.gif)
97-
* Use `Project Context` options incase you want to change to a different project context .
98-
![Switch Project Context](vscode/images/project_context.png)
99-
* Provide code snippets, markdown explanations, and expected outputs.
90+
* Use `Project Context` options in case you want to change to a different project context.<br/>
91+
![Switch Project Context](vscode/images/project_context.png)
92+
* Provide code snippets, markdown explanations, and expected outputs.
10093

10194
### Notebook Configurations
102-
* Following configuration settings are available
95+
* Following configuration settings are available
10396
* `jdk.notebook.classpath`
10497
* `jdk.notebook.modulepath`
10598
* `jdk.notebook.addmodules`
10699
* `jdk.notebook.enablepreview`
107100
* `jdk.notebook.implicitimports`
108-
* Note : These settings *override* any settings inferred from project context 
101+
* Note: These settings *override* any settings inferred from project context 
109102

110103
## JShell
111-
* Use the __Java: Open JShell...__ command to open JShell .
112-
* Project classes from currently open project are automatically loaded.
113-
![JShell](vscode/images/jshell.gif)
104+
* Use the __Java: Open JShell...__ command to open JShell.
105+
* Project classes from currently open project are automatically loaded.<br/>
106+
![JShell](vscode/images/jshell.gif)
114107

115108
## Debugger and Launch Configurations
116109
Language Server __Java+ ...__ launch configuration supports debugging and running Java applications using JDK11 or newer.
@@ -141,7 +134,7 @@ When using preview features use the quick fix action option to easily enable the
141134
![Enable Preview](vscode/images/enable_preview.gif)
142135
## Supported Refactorings
143136

144-
Class level refactorings as well as variable refactorings are supported in VSCode via Oracle Java Platform extension. See following screenshots:
137+
Class level refactorings as well as variable refactorings are supported in VS Code via the Oracle Java Platform extension. See the following screenshots:
145138

146139
### Source Action ... context menu
147140
![Class Source Actions](vscode/images/Source_actions.png)
@@ -188,36 +181,36 @@ Move members refactoring provides dedicated form as well.
188181
## Formatter Preferences
189182
Easily update default formatter preferences by adjusting a simple configuration option to tailor settings according to specific needs.
190183

191-
Go to VSCode `Open Settings | Extensions | Java` and set `Jdk › Format: Settings Path:` option to the formatter preferences file.
184+
Open VS Code `Settings | Extensions | Java` and set `Jdk › Format: Settings Path:` option to the formatter preferences file.
192185

193186
Please refer to [Java formatting preferences](https://github.com/oracle/javavscode/wiki/Java-formatting-preferences) wiki for more info.
194187

195188
## Hints Preferences
196189
Easily update default hint preferences by adjusting a simple configuration option to tailor hint preferences to specific needs.
197190

198-
Go to VSCode `Open Settings | Extensions | Java` and set `Jdk › Hints: Preferences:` option to the xml hint preferences file.
191+
Open VS Code `Settings | Extensions | Java` and set `Jdk › Hints: Preferences:` option to the xml hint preferences file.
199192

200193
## Organize Imports
201194
Out of the box support for organizing imports in Java sources is available. It removes unused imports, groups imports by packages and updates your imports whenever a file is saved. In addition to the defaults, there is a rich set of configuration options.
202195

203-
Go to VSCode `Open Settings | Extensions | Java` and search for _Jdk_ to set `Jdk > Java > Imports:` options:
196+
Open VS Code `Settings | Extensions | Java` and search for _Jdk_ to set `Jdk Java Imports:` options:
204197
* `Count For Using Star Import` - Class count to use a star-import, 999 is the default value
205198
* `Count For Using Static Star Import` - Members count to use a static star-import, 999 is the default value
206199
* `Groups` - Groups of import statements (specified by their package prefixes) and their sorting order. Import statements within a group are ordered alphabetically
207200

208-
And `Open Settings | Extensions > Java > On Save: Organize Imports` - Enable organize imports action on a document save
201+
The `Jdk › Java On Save: Organize Imports` setting in VS Code `Settings | Extensions | Java` enables the **Organize Imports** action to run when saving a document.
209202

210203
## JavaDoc smart editing
211-
When adding JavaDoc to code Oracle Java Platform extension assists by suggesting to insert preformatted and prepopulated JavaDoc comment. Type `/**` above method signature and IDE offers to complete the JavaDoc. The action creates JavaDoc comment with all arguments prepared.
204+
When adding JavaDoc to code Oracle Java extension assists by suggesting to insert preformatted and prepopulated JavaDoc comment. Type `/**` above method signature and IDE offers to complete the JavaDoc. The action creates JavaDoc comment with all arguments prepared.
212205
![JavaDoc Completion](vscode/images/javadoc.png)
213206

214207
## Test Explorer
215-
Oracle Java Platform extension provides Test Explorer view which allows to run all tests in a project, examine the results, go to source code and run particular test.
208+
Oracle Java extension provides Test Explorer view which allows to run all tests in a project, examine the results, go to source code and run particular test.
216209
![Test Explorer](vscode/images/Test_explorer.png)
217210

218211
### Localization support
219-
Oracle Java Platform extension provides localization support for _Japanese_ and _Simplified Chinese_.
220-
To switch language `Go to command Palette->Configure display language` select `ja` for _Japanese_ or `zh-cn` for _Simplified Chinese_
212+
Oracle Java extension provides localization support for _Japanese_ and _Simplified Chinese_.
213+
Use the `View | Command Palette | Configure Display Language` command to select `ja` for _Japanese_ or `zh-cn` for _Simplified Chinese_
221214

222215

223216
![Localization.gif](vscode/images/Localization.gif)
@@ -234,9 +227,8 @@ As soon as one of the settings is changed, the Language Server is restarted.
234227

235228
## How to use JDK early access builds
236229
This setup makes it easier to experiment with early access JDK builds. Follow these steps to enable the use of an early access JDK:
237-
Step-1: Navigate to `Open Settings | Jdk > Advanced > Disable: Nbjavac` and enable the checkbox.
238-
239-
Step-2: Set the JDK in `Open Settings | Jdk: Jdkhome` to point to the early access JDK path.
230+
1. Open VS Code `Settings | Jdk › Advanced › Disable: Nbjavac` and enable the checkbox.
231+
2. Set `Settings | Jdk: Jdkhome` to point to the home-folder path of the early access JDK.
240232

241233
## Troubleshooting
242234
If your extension is not starting and throwing some error like no JDK found even if you have a working JDK installed in your machine, then you can try deleting cache for the workspace using `View | Command Palette | Delete oracle java extension cache for this workspace`.

0 commit comments

Comments
 (0)