Update to version 0.4.0

1. added support for cursor tracking, automatic highlighting/expanding the corresponding parent & child entries
2. added support for customise highlight symbol
3. added support for preserving the collapsed/expanded state of TOC entries when navigating between different documents

Author: liqunkang

CHANGELOG.md

@@ -57,4 +57,10 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [0.3.1] - 2023-12-03
 
-- Added grammar syntax highlighting for the ORCA output file (syntax definition is saved in [`orca.tmLanguage.json`](syntaxes/orca.tmLanguage.json))
+- Added grammar syntax highlighting for the ORCA output file (syntax definition is saved in [`orca.tmLanguage.json`](syntaxes/orca.tmLanguage.json))
+
+## [0.4.0] - 2023-12-29
+
+- Added cursor position tracking for the ORCA output file. The TOC view will automatically highlight and expand the corresponding TOC entry when the user is navigating through the ORCA output file based on the current line number. The highlight and expand status of the TOC view will be updated when the user is moving the cursor to a different line in the ORCA output file.
+- Added support for changing the highlight symbols for the TOC entries.
+- Added support for saving the collapsed status of the TOC view in the settings of the extension. When navigating to different ORCA output files, the TOC view status for each file will be restored.

README.md

@@ -11,28 +11,37 @@ This an extension for Visual Studio Code that provides a separate toggleable TOC
 
 ## Features
 
-This extension provides a separate toggleable TOC view in the sidebar. The TOC view is automatically populated with the contents of the ORCA output file that is currently open in the editor. The TOC view is generated by parsing the ORCA output file using regular expressions and setting up a tree view based on the results. The generated TOC view is a tree view with the titles of the headings in the ORCA output file and the corresponding line numbers. Clicking on a TOC entry will jump to the corresponding line in the ORCA output file.
+This extension provides a separate toggleable TOC view in the sidebar. The TOC view can be toggled on and off by clicking on the `ORCA FILE OUTLINE` icon in the sidebar. The TOC view is automatically populated with the contents of the ORCA output file that is currently open in the editor. The TOC view is generated by parsing the ORCA output file using regular expressions and setting up a tree view based on the results.
+
+The generated TOC view is a tree view with the titles of the headings in the ORCA output file and the corresponding line numbers. Clicking on a TOC entry will jump to the corresponding line in the ORCA output file.
+
+By default all the parent entries are collapsed. While navigating through the ORCA output file using the cursor, the TOC view will automatically highlight and expand the corresponding parent entries and highlight the corresponding child entry. Moving the cursor to a different line will automatically update the TOC view by highlighting and expanding the new parent entries and highlighting the new child entry, while collapsing the previous parent entries and removing the highlight from the previous child entry.
+
+The collapsed status of the TOC view could also be changed by clicking the toggle arrow next to each parent entry. The manually changed collapsed status of the TOC view for each ORCA output file will be preserved when navigating between different ORCA output files.
 
 ![Outline Example](images/outline_example.png)
 
 ![Outline Example Expanded](images/outline_example_expanded.png)
 
-The TOC view can be toggled on and off by clicking on the `ORCA FILE OUTLINE` icon in the sidebar. The TOC view can also be toggled on by running the command `Show ORCA Outline` from the command palette. On Windows, the command palette can be opened with `Ctrl+Shift+P`, on Mac it is `Cmd+Shift+P`. The TOC view is automatically updated when navigating to a different ORCA output file.
-
-This plugin also provides syntax highlighting for the ORCA output file, including the headings, separation lines, numbers, and keywords, etc. The display of the syntax highlighting varies with different themes. Dark themes are recommended for better display of the syntax highlighting. To temporarily disable the syntax highlighting, please use the command `Change Language Mode` from the command palette and select `Plain Text`. To switch back to the syntax highlighting, please use the command `Change Language Mode` from the command palette and select `Auto Detect` or `ORCA-output`.
+The TOC view can also be triggered manually by running the command `Show ORCA Outline` from the command palette. On Windows, the command palette can be opened with `Ctrl+Shift+P`, on Mac it is `Cmd+Shift+P`. The TOC view is automatically updated when navigating to a different ORCA output file, or when an ORCA output file is opened.
 
 ![Command Palette Example](images/command_palette_example.png)
 
+This plugin also provides syntax highlighting for the ORCA output file, including the headings, separation lines, numbers, and keywords, etc. The display of the syntax highlighting varies with different themes. Dark themes are recommended for better display of the syntax highlighting. To temporarily disable the syntax highlighting, please use the command `Change Language Mode` from the command palette and select `Plain Text`. To switch back to the syntax highlighting, please use the command `Change Language Mode` from the command palette and select `Auto Detect` or `ORCA-output`.
+
 ## Requirements
 
 N/A
 
 ## Extension Settings
 
-The current version (0.3.1) enables changing the default status of the toggleable TOC view. The default collapsed status of the TOC view can be changed in the settings of the extension. The default value is `true`, which means that the TOC view is collapsed by default. The TOC view can be expanded by clicking on the `ORCA FILE OUTLINE` icon in the sidebar.
+The current version (0.4.0) enables changing the default status of the toggleable TOC view. The default collapsed status of the TOC view can be changed in the settings of the extension. The default value is `true`, which means that the TOC view is collapsed by default. The TOC view can be expanded by clicking the toggle arrow next to each parent entry.
 
 ![Setting: Collapse TOC view by default](images/setting_collapse_status.png)
 
+The current version (0.4.0) enables changing the highlight symbols for the TOC entries. The default highlight symbol is 'circle-large-filled'.
+For a list of available highlight symbols, please see [here](https://code.visualstudio.com/api/references/icons-in-labels#icon-listing).
+
 ## Issues and Important Notes
 
 - Due to the memory limit of VS Code for large files, could not process files larger than 50MB automatically. This is because the VS Code restricts the size of the `activeEditor` to 50MB, which prevents the extension from getting the contents of the opened ORCA output file. For more details, check the current open issue on Github [#31078](https://github.com/Microsoft/vscode/issues/31078).
@@ -51,19 +60,22 @@ The current version (0.3.1) enables changing the default status of the toggleabl
 
 For detailed release notes, please see [CHANGELOG.md](CHANGELOG.md).
 
-### 0.3.1
+### 0.4.0
 
-- Added grammar syntax highlighting for the ORCA output file (syntax definition is saved in [`orca.tmLanguage.json`](syntaxes/orca.tmLanguage.json))
+- Added cursor position tracking for the ORCA output file. The TOC view will automatically highlight and expand the corresponding TOC entry when the user is navigating through the ORCA output file based on the current line number. The highlight and expand status of the TOC view will be updated when the user is moving the cursor to a different line in the ORCA output file.
+- Added support for changing the highlight symbols for the TOC entries.
+- Added support for saving the collapsed status of the TOC view in the settings of the extension. When navigating to different ORCA output files, the TOC view status for each file will be restored.
 
 ## TODO
 
-- [ ] Highlight the corresponding TOC entry when the user is navigating through the ORCA output file based on the current line number.
+- [x] Highlight the corresponding TOC entry when the user is navigating through the ORCA output file based on the current line number.
 - [ ] Foldings feature for the ORCA output file based on the TOC entries.
-- [ ] Add support for the `ORCA FILE OUTLINE` view to automatically scroll to the current line in the ORCA output file.
+- [x] Add support for the `ORCA FILE OUTLINE` view to automatically scroll to the current line in the ORCA output file.
 - [x] Syntax highliting for the ORCA output file based on the TOC entries.
-- [ ] Add settings for enabling/disabling the syntax highlighting for the ORCA output file.
+- [x] Add settings for enabling/disabling the syntax highlighting for the ORCA output file.
 - [ ] Add command for unfold/fold all TOC entries
-- [ ] Add option to choose different highlight symbols for the TOC entries
+- [x] Add option to choose different highlight symbols for the TOC entries
+- [ ] Update illustration figures in this README
 
 ## Roadmap