Skip to content

0.2.0

Latest
Compare
Choose a tag to compare
@github-actions github-actions released this 06 Mar 17:23

0.2.0

One year to the day since my first ever release, I am happy to announce the release of version 0.2.0, the first
version of the plugin with the metadata rewrite, which has been months in the making.

Apologies for the long wait! I did not intend for this to take so long, but this update necessitated a lot of changes to the core of the plugin,
and most of the existing systems had to be rewritten from the ground up.

If you find any issues, please report them in the GitHub issues, or notify me in the Discord server.
I will try to get to them as soon as possible.
Additionally, I'd like to hear from you if you have any suggestions for future additions to the plugin,
so I can prioritize them accordingly.

Features

  • Metadata Extension
    • NOTE: Extension is purely opt-in via the Include Metadata Extension setting
    • Ranges (suggestions + comments) can now contain arbitrary metadata information, this is stored as a JSON encoded string
      and separated from the main contents by the @@ symbol, example: {++{"author":"Fevol"}@@This is a suggestion++}
    • Metadata is now added automatically to ranges when editing in suggestion mode or marking selections as a type
    • In the global view, you can filter the suggestions and ranges to filter by author or time range
  • Comment Replies Extension
    • Comments directly adjacent to other ranges are now considered as replies to that range
    • Ranges with replies will be highlighted in the editor
    • Comments with multiple replies are grouped together in global view and comment gutter
    • Comments can be automatically added to suggestions and other comments as replies
  • Global View
    • Suggestions can now be quickly accepted or rejected via Discord-style widget buttons
    • Added information on the amount of suggestions and/or comments in the current filter context
  • Comment Gutter
    • The gutter can now be resized via the settings
    • The gutter can now be folded away to have more editing space
    • Added button to the editor for toggling the fold state of the gutter (can be removed via settings)
    • Escape shortcut can now be used to exit a comment while editing
  • Commands
    • Cycle Preview mode: Cycle to the next preview mode for the current editor
    • Fold Gutter: Folds the comment gutter in the current editor
    • Add Comment: Adds a comment to the current location (or after the current suggestion) and focuses it
    • Generate text diff from clipboard: Creates a diff from clipboard and current selection and adds differences as CriticMarkup suggestions
  • Added Alternative Editing Mode (allows edits of text and ranges while ensuring that the CriticMarkup syntax is not broken)
  • Added option to hide the labels of editor header buttons
  • Added option to set the number of database workers for indexing the vault
  • Added toggle suggestion/preview mod buttons to statusbar (can be disabled via settings)
  • Added toggle for quickly enabling/disabling the addition of (specific types of) metadata
  • Comment Widgets (Icons) in editor can now be right-clicked to add a reply or focus the comment
  • Comments in Reading View are now rendered as icons with tooltip instead of inline (#7)

Changes

  • Suggestion mode
    • Deleting in an addition or addition-part of a substitution will now actually delete the characters instead of marking them as a deletion (#6)
    • Deletion/insertions into comments will not be considered as suggestion markup anymore
  • Edit mode and Preview mode settings are now editor-specific instead of global (default modes can be set in the settings)
  • Settings have been reorganized into different tabs
  • Editor header buttons now function similarly to the Read/Live Preview mode button
  • Using 'Mark range as...' command now adjusts the original selection to the new range
  • Performance improvements
    • Parsing and rendering now happens via incremental updates
    • Currently active file is now directly added to the database index (instead of being reparsed)
  • Rewrites
    • Cursor movement logic has been rewritten from the ground up to be more configurable
    • Suggestion logic is now rewritten as a mark-as extension to utilise generic mark functionality

Fixes

  • Improved comment gutter hiding behavior when empty
  • Improved comment gutter comment alignment problems
  • Fixed comment gutter comments in the same block being inconsistently ordered
  • Fix select-all not working in the editor
  • Cursor placement after suggestion edit is now more consistent
  • Prevent indexing of non-Markdown files in Database (#5)

Known Issues

  • Generate text diff from clipboard does not work well when range includes suggestions/other criticmarkup
  • Set metadata as 'completed' does nothing currently
  • Comments and markup being incorrectly rendered within tables