Feature Request: Pop up notes #489

Closed
opened 2026-02-04 20:32:32 +03:00 by OVERLORD · 6 comments
Owner

Originally created by @ghost on GitHub (Oct 27, 2017).

For Feature Requests

Desired Feature:
It would be nice to be able to insert a note in the documentation where it creates an indicator a note is available and hovering over the note displays additional information. Similar to a comment in Excel or Power Point.

Originally created by @ghost on GitHub (Oct 27, 2017). ### For Feature Requests Desired Feature: It would be nice to be able to insert a note in the documentation where it creates an indicator a note is available and hovering over the note displays additional information. Similar to a comment in Excel or Power Point.
OVERLORD added the 🛠️ Enhancement Open to discussion🔨 Feature Request labels 2026-02-04 20:32:32 +03:00
Author
Owner

@Shackelford-Arden commented on GitHub (Oct 27, 2017):

@dsaundersWizmo This is somewhat like what I had in mind in #428 maybe?

Though it might be beneficial if it has it's own issue (this one)?

@Shackelford-Arden commented on GitHub (Oct 27, 2017): @dsaundersWizmo This is somewhat like what I had in mind in #428 maybe? Though it might be beneficial if it has it's own issue (this one)?
Author
Owner

@ssddanbrown commented on GitHub (Nov 7, 2017):

Hi @dsaundersWizmo, Thanks for the suggestion.

I think that linking the comment system into this to be able to link a comment/note to a particular block of content is a well suited request for BookStack.

It just becomes a little bit more challenging when deciding what to do upon changes. For example, What happens when the block of content is moved/updated/destroyed?
What if the comment on the note is resolved? Who can mark it as resolved?

@ssddanbrown commented on GitHub (Nov 7, 2017): Hi @dsaundersWizmo, Thanks for the suggestion. I think that linking the comment system into this to be able to link a comment/note to a particular block of content is a well suited request for BookStack. It just becomes a little bit more challenging when deciding what to do upon changes. For example, What happens when the block of content is moved/updated/destroyed? What if the comment on the note is resolved? Who can mark it as resolved?
Author
Owner

@tuedang commented on GitHub (Nov 14, 2017):

Hi @ssddanbrown
I am the guy implemented the 'Inline Comment' in Confluence, and would like to share some main ideas:

  • The note is also a comment, it just has another attribute to mark it as 'comment'
  • Who can comment on page, they can create note.
  • So it follows all the rules of comment on edit, update, delete, reply (if we want to reply a note)
  • Comment link to page, page deletion will delete all comments, include note.
  • The moving content will make note become dangling status
  • We need another screen to manage 'dangling', 'resolved' note (could be a popup)
@tuedang commented on GitHub (Nov 14, 2017): Hi @ssddanbrown I am the guy implemented the 'Inline Comment' in Confluence, and would like to share some main ideas: - The note is also a comment, it just has another attribute to mark it as 'comment' - Who can comment on page, they can create note. - So it follows all the rules of comment on edit, update, delete, reply (if we want to reply a note) - Comment link to page, page deletion will delete all comments, include note. - The moving content will make note become `dangling` status - We need another screen to manage 'dangling', 'resolved' note (could be a popup)
Author
Owner

@openmoto commented on GitHub (May 15, 2019):

Hi Guys,
As an interim solution, you can add HTML span tag to your documentation.
While Editting, click on source code <>
Say you want to add a pop up note to the text "apple"..

(replace the # with the less than sign '<' and the ## with the greater than sign '>')

Add
#span title="A fleshy,usually rounded red, yellow, or green edible pome fruit"##
before the word, then add
#/span##
after the word.

Apparently it works everywhere including this comment.
Which is why I couldn't paste the exact code, it just adds the mouse-over pop up.
Hope this helps.

Implementing this through a single click could be a quick way to do it but can't say if its a good way as per best practices and compatibility.

Screenshot below:
image

@openmoto commented on GitHub (May 15, 2019): Hi Guys, As an interim solution, you can add HTML span tag to your documentation. While Editting, click on source code <> Say you want to add a pop up note to the text "apple".. (replace the # with the less than sign '<' and the ## with the greater than sign '>') Add #span title="A fleshy,usually rounded red, yellow, or green edible pome fruit"## before the word, then add #/span## after the word. Apparently it works everywhere including this comment. Which is why I couldn't paste the exact code, it just adds the mouse-over pop up. Hope this helps. Implementing this through a single click could be a quick way to do it but can't say if its a good way as per best practices and compatibility. Screenshot below: ![image](https://user-images.githubusercontent.com/36439190/57800916-cb44a880-770f-11e9-8ed4-3b2c3a01e10c.png)
Author
Owner

@YuntiDevOps commented on GitHub (Apr 17, 2022):

+1

@YuntiDevOps commented on GitHub (Apr 17, 2022): +1
Author
Owner

@ssddanbrown commented on GitHub (Sep 7, 2025):

I'm going to go ahead and close this off since v25.05 introduced content-comments which essentially achieves the fundamental request here:
https://www.bookstackapp.com/blog/bookstack-release-v25-05/#content-comments

Thanks all for your input.

@ssddanbrown commented on GitHub (Sep 7, 2025): I'm going to go ahead and close this off since v25.05 introduced content-comments which essentially achieves the fundamental request here: https://www.bookstackapp.com/blog/bookstack-release-v25-05/#content-comments Thanks all for your input.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#489