Hello everyone, apologies for the long lack of updates in this forum thread. I have been working on this plugin again for the past couple months. You may have noticed, for instance, that a couple months ago that this plugin didn’t start up anymore, well, that has been fixed! (I sincerely apologize for that major inconvenience…!)
As always, you can find all changes on the GitHub releases page, but to give a short overview of the largest additions:
In-editor Annotation gutter (formerly the ‘comment gutter’)
Added live preview while editing comments
Resize the gutter to your desired width, and remember it across reloads
Show not only comments, but also additions/deletions/… inside the gutter (can be filtered)
Focusing an annotation in the editor will also focus it in the gutter
(!) Added the ability to properly remove comments
Reveal CriticMarkup syntax while editing in ‘regular’ mode, just like how Obsidian handles **bold**/_italic_ markup
…and many more improvements!
For the next couple hours after writing this post, I’m going to work on updating the roadmap of this plugin, and creating new issues on GitHub for all the major features.
Thanks for using this plugin, and please, do share feedback if you have any (in this thread or GitHub).
Also, please be aware that the dedicated Commentator thread in the Discord server was moved a couple months ago, it can now be found here! This is where I am usually most active, and it’s also where I discuss and showcase new features before releasing them on GitHub.
If you’ve been using this plugin, I would love to hear your feedback on what should/could be improved before the future official release in the community plugin browser. This can be about anything: problems that need to be fixed, things that you want to be able to do, …
I’ve also opened a couple issues for future additions and changes, where I describe my plans on how I would implement e.g. the comment mode and highlight mode.
I am so new to Obsidian so I apologize if this is just a crazy simple question but do I need to have the CriticMarkup plugin before I download or use your plugin?? This is an awesome thing you’ve made and I’m excited to start using it!
Sorry for the late reply! Commentator and the Criticmarkup plugin are one and the same (obsidian-criticmarkup is just the original repository name). You don’t need to install anything else to get the plugin working. (If it doesn’t start up, please let me know!)
The simplest way to get the plugin installed, is as follows:
Open Obsidian
Enable Community plugins in Obsidian’s settings
Search for BRAT in the community plugins browser, install and enable it
Open the Command Palette (Ctrl/Cmd + P) and type in BRAT: Plugins: Add a beta plugin for testing (with or without version)
Paste the following link in Repository field: https://github.com/Fevol/obsidian-criticmarkup (make sure that there is no / at the end of the URL!)
New update notice: version 0.2.5 has been released.
The main highlights of this version includes a complete overhaul of the comment icons within the editor), and much improved handling of the annotation gutter when you have Readable Line Width enabled.
Would it be possible to make an additional toggle command which swaps between suggesting and editing (regular)? Instead of editing (corrected). As the current toggle suggestion mode defaults to editing (corrected).
Love the plugin though! It has been so helpful in editing texts.
Yeah, I can absolutely add that, I’ve opened up an issue for it here. Feel free to add more feature requests!
If you don’t mind, I would also be really interested in hearing about what your opinions are on editing (regular) vs. editing (corrected), and how you use them.
And sure, it purely a preference thing. Now, I am not entirely sure what the precise differences between the two modes are. From using them it seems that the editing (corrected) mode hides the syntax. This is great if you prefer WYSIWYG. But when I edit a line I want to be able to see the syntax, as otherwise it feels like it is easy to break something. Even when I hide something with css, I make sure it is visible when the line is active (cursor is on it).
Another reason is that I use Latex Suite to quickly create comments, or single edits (when going into suggestion mode is overkill). This can get messy if I mess up by accident, so I have to be able to see the syntax. Which is why I cannot use editing (corrected).
Yeah, the descriptions of the modes could be improved a lot. Maybe to give some insight, currently, the two modes are implemented as follows:
Editing Mode (Regular)
(Partially) selecting an annotation will reveal all syntax
All edits are unchanged
You are able to ‘illegally’ change the metadata of an annotation, or mess up the syntax
Editing Mode (Corrected)
Syntax will stay hidden even when selecting
Regardless of what edits you make, the syntax will always be preserved
(not implemented) This mode prevents you from making edits to annotations by different authors
When moving the cursor with arrows, any markup is ignored
I personally think both modes are necessary, but I’m finding it quite difficult to properly communicate how the two mode differ. That’s why it’s very useful to hear about how you use the plugin, thanks again!