Skip to content

Commit

Permalink
update documentation and changes and minor fixes in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Alidra committed Dec 17, 2024
1 parent f7404c9 commit a5788a2
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 14 deletions.
32 changes: 21 additions & 11 deletions doc/vscode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,27 @@ Make sure you have a `lambdapi.pkg <https://lambdapi.readthedocs.io/en/latest/mo

Goals are visualised in a panel on the right side of the editor. You can
navigate in proof with the following key-bindings:

- ``Ctrl+Right``: go one step forward
- ``Ctrl+Left``: go one step backward
- ``Ctrl+Up``: go to the previous proof (or the beginning)
- ``Ctrl+Down``: go to the next proof (or the end)
- ``Ctrl+Enter``: go to the position of the cursor
- ``Ctrl+Alt+c``: toggle cursor mode (proof highlight follows the
cursor or not)
- ``Ctrl+Alt+w``: toggle follow mode (proof highlight is always
centered in the window when keybindings are pressed)
- ``Shift+Alt+w``: center proof highlight in the current window
***Linux and Windows***
- ``Ctrl+Right``: go one step forward
- ``Ctrl+Left``: go one step backward
- ``Ctrl+Up``: go to the previous proof (or the beginning)
- ``Ctrl+Down``: go to the next proof (or the end)
- ``Ctrl+Enter``: go to the position of the cursor
- ``Ctrl+Alt+c``: toggle cursor mode (proof highlight follows the cursor or not)
- ``Ctrl+Alt+w``: toggle follow mode (proof highligsht is always centered in the window when keybindings are pressed)
- ``Shift+Alt+w``: center proof highlight in the current window

***Mac OS X***
- ``Ctrl+fn+Right``: go one step forward
- ``Ctrl+fn+Left``: go one step backward
- ``Ctrl+Alt+Up``: go to the previous proof (or the beginning)
- ``Ctrl+Alt+Down``: go to the next proof (or the end)
- ``Ctrl+Enter``: go to the position of the cursor
- ``Ctrl+Alt+c``: toggle cursor mode (proof highlight follows the cursor or not)
- ``Ctrl+Alt+w``: toggle follow mode (proof highlight is always centered in the window when keybindings are pressed)
- ``Shift+Alt+w``: center proof highlight in the current window

Please note that these key-bindings can be changed in Code->Preferences->keyboard shortcuts (also reachable with Ctrl+K Ctrl+S or Command+K Command+S in Mac OS X).

**Hover and go-to-definition**

Expand Down
9 changes: 9 additions & 0 deletions editors/vscode/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/),
and this project adheres to [Semantic Versioning](https://semver.org/).

## Unreleased

### Added

### Fixed

### Changed
- Changed the `go to the previous/next proof` commands shortcuts for Mac OS X operating system because previous ones are used by Mac OS.

## [0.2.2]
- code refactoring of the client for maintenability.
- fix the bug that causes the proof navigation to malfunction when the `Goals` panel is closed by the user. Now the panel is recreated whenever needed. If focus is taken away frol the `Goals` panel, focus is given back to it when user starts navigating proofs again.
Expand Down
6 changes: 3 additions & 3 deletions editors/vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ You can navigate in proof with the following key-bindings:
***Mac OS X***
- ``Ctrl+fn+Right``: go one step forward
- ``Ctrl+fn+Left``: go one step backward
- ``Ctrl+Up``: go to the previous proof (or the beginning)
- ``Ctrl+Down``: go to the next proof (or the end)
- ``Ctrl+Alt+Up``: go to the previous proof (or the beginning)
- ``Ctrl+Alt+Down``: go to the next proof (or the end)
- ``Ctrl+Enter``: go to the position of the cursor
- ``Ctrl+Alt+c``: toggle cursor mode (proof highlight follows the cursor or not)
- ``Ctrl+Alt+w``: toggle follow mode (proof highlight is always centered in the window when keybindings are pressed)
- ``Shift+Alt+w``: center proof highlight in the current window

Please note that these key bindings can be changed in Code->Preferences->keyboard shortcuts (also reachable with Ctrl+K Ctrl+S or Command+K Command+S in Mac OS X).
Please note that these key-bindings can be changed in Code->Preferences->keyboard shortcuts (also reachable with Ctrl+K Ctrl+S or Command+K Command+S in Mac OS X).

**Hover and go-to-definition**

Expand Down

0 comments on commit a5788a2

Please sign in to comment.