Skip to content

Commit e3881ca

Browse files
committed
update to v0.3.0
- 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. - Added support for automatically showing TOC view when opening an ORCA output file. (bug fix) - Added instruction screenshots to this README.
1 parent f3b4082 commit e3881ca

File tree

7 files changed

+25
-9
lines changed

7 files changed

+25
-9
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
4848
## [0.2.4] - 2023-10-28
4949

5050
- Update of `keywords.json` file
51+
52+
## [0.3.0] - 2023-11-18
53+
54+
- 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.
55+
- Added support for automatically showing TOC view when opening an ORCA output file. (bug fix)
56+
- Added instruction screenshots to this README.

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,23 @@ This an extension for Visual Studio Code that provides a separate toggleable TOC
1313

1414
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.
1515

16+
![Outline Example](images/outline_example.png)
17+
18+
![Outline Example Expanded](images/outline_example_expanded.png)
19+
1620
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.
1721

22+
![Command Palette Example](images/command_palette_example.png)
23+
1824
## Requirements
1925

2026
N/A
2127

2228
## Extension Settings
2329

24-
The current version (0.2.4) of this extension does not have any settings.
30+
The current version (0.3.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 on the `ORCA FILE OUTLINE` icon in the sidebar.
31+
32+
![Setting: Collapse TOC view by default](images/setting_collapse_status.png)
2533

2634
## Issues and Important Notes
2735

@@ -41,17 +49,19 @@ The current version (0.2.4) of this extension does not have any settings.
4149

4250
For detailed release notes, please see [CHANGELOG.md](CHANGELOG.md).
4351

44-
### 0.2.4
52+
### 0.3.0
4553

46-
Bug fixes and optimizations.
54+
- 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.
55+
- Added support for automatically showing TOC view when opening an ORCA output file. (bug fix)
56+
- Added instruction screenshots to this README.
4757

4858
## TODO
4959

50-
- [x] Automatically show TOC view when opening an ORCA output file
51-
- [X] Support for large ORCA output files (>50MB).
52-
- [ ] Add illustrations to this README
53-
- [x] Add icon to this extension
54-
- [x] Updating the list of regular expressions used to parse the ORCA output file
60+
- [ ] Highlight the corresponding TOC entry when the user is navigating through the ORCA output file based on the current line number.
61+
- [ ] Foldings feature for the ORCA output file based on the TOC entries.
62+
- [ ] Add support for the `ORCA FILE OUTLINE` view to automatically scroll to the current line in the ORCA output file.
63+
- [ ] Formatter for the ORCA output file based on the TOC entries.
64+
5565

5666
## Roadmap
5767

images/command_palette_example.png

14.7 KB
Loading

images/outline_example.png

221 KB
Loading
114 KB
Loading

images/setting_collapse_status.png

92.8 KB
Loading

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "orcatoc",
33
"displayName": "orca_toc",
44
"description": "Provides an outline for ORCA files in the VS Code sidebar.",
5-
"version": "0.2.4",
5+
"version": "0.3.0",
66
"engines": {
77
"vscode": "^1.82.0"
88
},

0 commit comments

Comments
 (0)