Skip to content

Commit

Permalink
Update package, Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ThFriedrich committed Sep 3, 2020
1 parent 479897f commit 9b6a413
Show file tree
Hide file tree
Showing 5 changed files with 2,188 additions and 2,090 deletions.
35 changes: 35 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,40 @@ All notable changes to the "lammps_vscode" extension will be documented in this
## Version 1.3.0 08.08.2020
- CI for Synchronisation with the Lammps documentation, Github publishing and automatic Marketplace publishing

## Version 1.3.2 14.08.2020
- Scheduled synchronisation of lammps_vscode with Lammps documentation

## Version 1.4.0 03.09.2020
- Synchronisation of lammps_vscode with Lammps documentation
- Task Provider
- Lammps can now be run as a task from within vscode
- Settings added for:
- __binary__: path to the Lammps executable
- __mpi_tasks__: # of MPI tasks to run for parallel execution
- __gpu_nodes__: # of GPU Nodes to use with the *gpu* package
- Task type *"lmps"* provided to set up tasks manually in a *tasks.json* file
- Hover Feature
- Documentation links in hover boxes now open the embedded documentation pages inside vscode instead of pointing to the weblink
- Package now bundles all images with versions in width=256px, used by the Hover only
- Auto Completion
- Documentation links in autocomplete-info boxes now open the embedded documentation pages inside vscode instead of pointing to the weblink
- Autocomplete suggestions are now only triggered at the beginning of lines
- Grammar
- Keywords updated
- Updates to Grammar rules to avoid some false positive
- Offline embedded documentation
- Improved layout of "Note" and "Warning" sections
- fix missing rst-file includes
- fixed several formatting issues
- added Syntax highlighting support through vscode-textmate and markdown-it.
- added standard light/dark css-files to control syntax highlighting in the webview. (because Token-Colors are not exposed through vscode API yet)
- Depencies added:
- markdown-it
- plist
- request
- underscore-plus
- vscode-oniguruma
- vscode-textmate



58 changes: 35 additions & 23 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,43 @@
# Release Notes v.1.3
# Release Notes v.1.4.0

In this update some major changes were introduced and features added. Please [report issues](https://github.com/ThFriedrich/lammps_vscode/issues/new/choose) if you encounter any problems so they can be fixed. Much of the content of this extension is generated in an automated fashion from the official [Lammps documentation](https://lammps.sandia.gov/doc/Manual.html). It is hardly possible to check the behaviour of autocomplete and hover features for each individual command, what makes bug reports all the more important and valueable. Also, please share your ideas for enhancements or new features.

If you have to or want to revert to a previous release, please download the corresponding vsix-package from [GitHub](https://github.com/ThFriedrich/lammps_vscode/releases) and [install it](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) from the command line with the following command:
```bash
code --install-extension lammps-1.2.4.vsix
```
In this update some minor changes were introduced and features added. Please [report issues](https://github.com/ThFriedrich/lammps_vscode/issues/new/choose) if you encounter any problems so they can be fixed. Much of the content of this extension is generated in an automated fashion from the official [Lammps documentation](https://lammps.sandia.gov/doc/Manual.html). It is hardly possible to check the behaviour of autocomplete and hover features for each individual command, what makes bug reports all the more important and valueable. Also, please share your ideas for enhancements or new features.

---

### This Release introduces the following new features and improvements:

## Auto Completion
Completion suggestions now behave much like snippets. Editable arguments are accessed by tabbing (<kbd>Tab</kbd>) through them. Variables can be edited like text. Arguments that allow specific choices should show a dropdown list with options to choose from. Words that are part of the command description are automatically inserted.

## Hover Feature
* Rendering Equations is now supported using MathJax
* Fixed many styling issues
This package is [Treeware](https://treeware.earth). If you find this extension useful, then we ask that you [🌱 **buy the world a tree**](https://plant.treeware.earth/thfriedrich/lammps_vscode) to thank us for our work.

## Offline embedded documentation
* right click on command allows to show documentation in new vscode-panel
---

## Linting functions
* Set of functions that points out problems before runtime
* So far only checking for files and paths on read- and write commands
* To be extended in the future
## This Release introduces the following new features and improvements:


- ### Synchronisation of lammps_vscode with Lammps documentation
- ### Task Provider
- Lammps can now be run as a task from within vscode
- Settings added for:
- __binary__: path to the Lammps executable
- __mpi_tasks__: # of MPI tasks to run for parallel execution
- __gpu_nodes__: # of GPU Nodes to use with the *gpu* package
- Task type *"lmps"* provided to set up tasks manually in a *tasks.json*-file
- ### Hover Feature
- Documentation links in hover boxes now open the embedded documentation pages inside vscode instead of pointing to the weblink
- ### Auto Completion
- Documentation links in autocomplete-info boxes now open the embedded documentation pages inside vscode instead of pointing to the weblink
- Autocomplete suggestions are now only triggered at the beginning of lines
- ### Grammar
- Keywords updated
- Updates to Grammar rules to avoid some false positive matches
- ### Offline embedded documentation
- Improved layout of "Note" and "Warning" sections
- fix missing rst-file includes
- fixed several formatting issues
- added Syntax highlighting support through vscode-textmate and markdown-it.
- added standard light/dark css-files to control syntax highlighting in the webview. (because Token-Colors are not exposed through vscode API yet)
---

## Automatic Updates
* The build of this extension is fully automated to synchronise it's contents with the Official Lammps documentation on a monthly schedule
If you have to or want to revert to a previous release, please download the corresponding vsix-package from [GitHub](https://github.com/ThFriedrich/lammps_vscode/releases) and [install it](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) from the command line with the following command:
```bash
code --install-extension lammps-1.2.4.vsix
```
---

Loading

0 comments on commit 9b6a413

Please sign in to comment.