Skip to content

Content Comments #5584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 16 commits into
base: development
Choose a base branch
from
Open

Content Comments #5584

wants to merge 16 commits into from

Conversation

ssddanbrown
Copy link
Member

@ssddanbrown ssddanbrown commented Apr 18, 2025

Related to #1265

Todo

  • Inline comment display
    • Option for controlling display
      • Omitting this for initial implementation as we'll gather some feedback about best placement and control level.
    • Selection zone representation (on focus/click?)
    • Indicator for if the comment is outdated
  • WYSIWYG display?
  • Update reference hash to be focused on text content, otherwise too much variance (eg, when loaded in editor).
  • MD editor display?
    • The MD editor cycle is too loose to retain accurate references, so retaining editor support to the new WYSIWYG.
  • Comment archival handling
  • Test changes to pointer work across presentation variation (change of edit/comment permissions etc...)
  • Test accessible use of pointer remains, including added comment action
  • Test use in old WYSIWYG (references remain inactive but don't break anything).

Adds button for comments to pointer.
Adds logic to generate a content reference point.
@ssddanbrown ssddanbrown self-assigned this Apr 18, 2025
Made changes for dom and translation services for easier usage
considering types.
trans_choice updated to allow default count replacement data as per
Laravel's default behaviour.
Also added archived property, to be added.
@MfeaR
Copy link

MfeaR commented Apr 22, 2025

Hi! Could you please clarify if this feature will be implemented, and if so, when? We're evaluating documentation apps, and this is the only feature preventing us from choosing BookStack.

@ssddanbrown
Copy link
Member Author

@MfeaR This is a work in progress attempt at a feature. My aim is for this to be in the next feature release (so maybe late May or June) but can't promise anything.

Started support for editor view.
Moved comment elements to be added relative to content area instad of
specific target reference element.
Added relocating on screen size change.
Handles only display and handling references when they're in the active
tab, while handling proper removal when made not visible.
- Added reference indicator to comment create form.
  - Added remove action.
- Extracted reference text to translations.
- Changed reference hash to be text-based instead of HTML based.
- Added reference display for newly added comments.
- Handled reference marker delete on comment delete.
Also added default non-clickable styles for scenarios for references
which don't have an active content link.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants