🤖 AI Summarization Plugin - Pre-Released First Version (v.0.1) 🚀

GSoC Projects Summarize with AI
4

Great work! Nice to test the plugin with my feedback added. I have other feedback alongside testing results. Please let me know if you have any questions.

Testing

  • Clicking OK or Cancel in the Summarize the notebook dialog throws a console error
  • Summarizing multiple selected notes by Ctrl or Shift click only summarizes the last selected note
  • Clicking on new line H1, H2, and Bullet list options don't do anything

These results can be compared with the video demonstration.

  • The notebook tree doesn't appear so I can't test the panel flow
  • Summary Title, Length, and Algorithms options are missing
  • Note: doesn't populate with note title
  • Default editor input decoration isn't visible

Feedback

GUI Preference

Make summarizing a 1 step process through dialog or panel based on a GUI preference in settings, as seen in the Search and Replace plugin screenshots.

  • With either mode, the editor and all options show at once, and OK then Save gets condensed to Save
  • With panel mode, comparison is permitted and Laurent's idea of displaying the current note's summary is met
  • With dialog mode, dialog appears on shortcut or context menu click and disappears on Save or Cancel button press

If the above is too confusing or too much work, can all options go into the panel?

Identifying summarized notes

This can be handled with plugin features and/or existing tooling:

  • Setting custom note titles and/or headers can allow search (plugins) to find or list summaries in one place
  • Sending summaries to designated notebooks (whether for all summaries or specific kinds) can serve the same function
  • Adding (inline) tags for summaries can also serve the same function

With these methods, you can skip duplicating the notebook tree, let alone filtering notes.

Visuals

  • Add instructions above summary editor, including instructions to show toolbar when highlighting text
  • Make editor fill remaining vertical space in panel, if any (editor height is fixed at 400px)
    • Scrollbar unexpectedly shows up right of editor whether editor is under or over fixed height
  • Remove excess spacing (padding, margin, etc.) and condense elements
    • For example, Search and Replace and VS Code Search plugins minimize whitespace and use space well
    • This minimizes panel resizing like in the video
    • This permits maximal editor space
  • Improve color contrast:
    • Make highlighted text toolbar background white
    • Use black or color with enough contrast for block quote, active editor input decoration
  • Add dark mode based on system default and/or dark theme selection
  • Show or hide the panel based on whether it was open or closed before quitting Joplin

Interactions

  • Change default keyboard shortcut to one without conflicts (VS Code Search plugin defaults to Ctrl+Shift+F)
  • Prevent note summarization after clicking Cancel or pressing Esc
  • Add simple interactive or text explanations for any summary options a user might not understand
  • Create radio button set for summary location including Above current note, Below current note, and Create new note

Manifest

  • If possible without changing plugin ID, change plugin name to "AI Summarisation" to match existing naming (plugin ID, Github URL, etc.)
  • Add "summary" to keywords and/or description so users searching for "summary" can find it
2 Likes